Skip to content

collection, core (10): Add Scaladoc comments for undocumented entities - #26907

Draft
bvenners wants to merge 1 commit into
scala:mainfrom
artimahub:scaladoc-missing-docs-collection-core
Draft

bvenners wants to merge 1 commit into
scala:mainfrom
artimahub:scaladoc-missing-docs-collection-core

Conversation

@bvenners

Copy link
Copy Markdown
Contributor

This PR fills in a main doc comment plus @PARAM, @tparam, and @return tags for the root of scala.collection that is completely missing any Scaladoc documentation. It covers the Iterable, Seq, Set and Map hierarchies and their Ops traits, the views, the steppers and stepper shapes, and the factory and build-from machinery. 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.

Documents declarations that had no doc comment at all in the root of
scala.collection: the Iterable, Seq, Set and Map hierarchies and their Ops
traits, the views, the steppers and the factory machinery.

Comment-only: no declaration, body, import, annotation or blank line is
touched.
@bvenners
bvenners force-pushed the scaladoc-missing-docs-collection-core branch from 67a3db7 to 23fb295 Compare September 10, 2026 06:38
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.

1 participant