collection, immutable, List, LazyList, sorted (12): Add Scaladoc comments for undocumented entities - #26909
Draft
bvenners wants to merge 1 commit into
Conversation
…d and tree collections Documents declarations that had no doc comment at all in the linear, lazy and ordered collections of scala.collection.immutable: List and Set with the small-arity Set1 to Set4 family, the lazy sequences LazyList, LazyListIterable and the deprecated Stream, the red-black tree maps and sets, the sorted and list-backed maps and sets, Queue, WrappedString, the ranges, and the integer-keyed maps. Comment-only: no declaration, body, import, annotation or blank line is touched.
bvenners
force-pushed
the
scaladoc-missing-docs-collection-immutable-list-lazylist-sorted
branch
from
September 10, 2026 06:44
1306080 to
fbce8e9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fills in a main doc comment plus @PARAM, @tparam, and @return tags for the linear, lazy and ordered collections of
scala.collection.immutablethat are completely missing any Scaladoc documentation:List,Setwith its small-aritySet1toSet4family, the lazy sequencesLazyList,LazyListIterableand the deprecatedStream, the red-black tree maps and sets, the sorted and list-backed maps and sets,Queue,WrappedString, the ranges and the integer-keyed maps. I'm submitting it as a draft PR so that I can get the CI to run on it, to see if it breaks anything, and to start getting feedback. We automated the generation of these changes and have not reviewed all of them yet. We will review them all before making the PR non-draft. Please let me know whether you think this is going in the right direction in general, and anything specific that you notice that could be improved.