Skip to content

Update the collection guide for 2.13 #1227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 6, 2019

Conversation

julienrf
Copy link
Contributor

@julienrf julienrf commented Nov 27, 2018

Fixes #995

I’ve split the PR into two commits for easier review. The first commit duplicates the current collection guide into a “Scala 2.13” guide, without changing its contents. The second commit applies the necessary changes. As a result, you can review just the second commit to see the differences with the current collections guide.

Here are some screenshots of the layout and diagrams.

index
overview-root
overview-immutable
overview-mutable

@julienrf julienrf force-pushed the new-collections-guide branch from 06eb802 to 22e302c Compare November 27, 2018 13:48
@propensive
Copy link
Contributor

Could you review, please, @szeiger?

@SethTisue SethTisue self-assigned this Feb 21, 2019
@SethTisue
Copy link
Member

Could you review, please, @szeiger?

(we need to finish 2.13.0-RC1 first, then we'll give higher priority to doc work)

@SethTisue
Copy link
Member

note to self, I should go ahead and give this a light round of review and then merge it. if it needs more work we can always improve it further later

@SethTisue
Copy link
Member

SethTisue commented Mar 5, 2019

@julienrf would you mind fixing this up before merge?

- ./_site/overviews/collections-2.13/concrete-immutable-collection-classes.html
  *  External link http://www.scala-lang.org/api/2.12.2/scala/collection/immutable/ArraySeq.html failed: 404 No error
  *  External link http://www.scala-lang.org/api/2.12.2/scala/collection/immutable/LazyList.html failed: 404 No error
  *  External link http://www.scala-lang.org/api/2.12.2/scala/collection/immutable/VectorMap.html failed: 404 No error
- ./_site/overviews/collections-2.13/concrete-mutable-collection-classes.html
  *  External link http://www.scala-lang.org/api/2.12.2/scala/collection/mutable/ArrayDeque.html failed: 892
- ./_site/overviews/collections-2.13/iterators.html
  *  External link http://www.scala-lang.org/api/2.12.2/scala/collection/IterableOnce.html failed: 404 No error
- ./_site/overviews/collections-2.13/overview.html
  *  External link http://www.scala-lang.org/api/current/scala/collection/immutable/LazyList.html failed: - ./_site/overviews/collections-2.13/trait-iterable.html
  *  External link http://www.scala-lang.org/api/current/scala/collection/IterableOnce.html failed: 404 No error
  *  External link https://www.scala-lang.org/api/current/scala/collection/SetOps.html failed: 404 No error

@julienrf
Copy link
Contributor Author

julienrf commented Mar 5, 2019

These links are computed by using the site.scala-version variable, which happens to be set to 2.12.2. Should I hardcode them to use 2.13.0-M5 instead?

@SethTisue
Copy link
Member

SethTisue commented Mar 5, 2019

hardcoding would be fine. if you're feeling a little more ambitious, you could add a site.scala-213-version variable

I'll submit a separate PR bumping site.scala-version (#1294), and I'll add updating that to our release steps for Scala

julienrf added 3 commits March 5, 2019 22:57
Its content is copied from the current “Collections” guide.
- Remove documentation of deprecated or removed collections
  (Traversable, immutable.Stack, LinkedList, DoubleLinkedList,
  synchronized sets and maps), operations (toStream, copyToBuffer, hasDefiniteSize, addition and removal
  operations on root collections, union, reverseMap, prefixLength) and generic package
- Update documentation of collections that have been replaced
  by other collections (Stream, WrappedArray, HashMap, HashSet,
  ArrayStack, View), or renamed operations (retain, transform)
- Add documentation for new collections (immutable.ArraySeq,
  VectorMap, ArrayDeque) and new operations (unfold, toLazyList,
  knownSize, distinct, distinctBy, groupMap, groupMapReduce, xxxInPlace,
  sizeCompare, sizeIs, minOption, maxOption)
- Harmonize code style
    - don’t use infix syntax with operations taking more than one param
    - show alphabetic name of operations before showing their symbolic
      alias
- Remove “Migrating from 2.7” page
@julienrf julienrf force-pushed the new-collections-guide branch from 2422d0e to 151c0a0 Compare March 5, 2019 21:58
@julienrf
Copy link
Contributor Author

julienrf commented Mar 5, 2019

I felt ambitious.

@julienrf julienrf force-pushed the new-collections-guide branch from 151c0a0 to ff77e62 Compare March 5, 2019 22:25
@SethTisue SethTisue merged commit 694061b into scala:master Mar 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants