Skip to content

Collection immutable (3): fill in missing @param, @tparam, and @return tags in Scaladoc comments - #25373

Merged
SolalPirelli merged 1 commit into
scala:mainfrom
artimahub:scaladoc-tags-collection-immutable
Apr 28, 2026
Merged

Collection immutable (3): fill in missing @param, @tparam, and @return tags in Scaladoc comments#25373
SolalPirelli merged 1 commit into
scala:mainfrom
artimahub:scaladoc-tags-collection-immutable

Conversation

@bvenners

Copy link
Copy Markdown
Contributor

As a next step in improving the Scaladoc documentation for the Scala 3 standard library, this PR fills in missing @param, @tparam, and @return tags for collection immutable. 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.

@bvenners
bvenners force-pushed the scaladoc-tags-collection-immutable branch from 6fe375a to 8bca0bc Compare February 27, 2026 21:30

@cheeseng cheeseng left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sanity check comments.

Comment thread library/src/scala/collection/immutable/HashMap.scala
Comment thread library/src/scala/collection/immutable/HashMap.scala
Comment thread library/src/scala/collection/immutable/HashMap.scala
Comment thread library/src/scala/collection/immutable/HashMap.scala
Comment thread library/src/scala/collection/immutable/HashSet.scala
Comment thread library/src/scala/collection/immutable/Vector.scala Outdated
Comment thread library/src/scala/collection/immutable/Vector.scala Outdated
Comment thread library/src/scala/collection/immutable/Vector.scala Outdated
Comment thread library/src/scala/collection/immutable/Vector.scala Outdated
Comment thread library/src/scala/collection/immutable/Vector.scala Outdated
@bvenners
bvenners force-pushed the scaladoc-tags-collection-immutable branch 3 times, most recently from 25608bf to 1b5774c Compare April 18, 2026 03:36
@bvenners
bvenners marked this pull request as ready for review April 18, 2026 03:36
@bvenners
bvenners requested a review from a team as a code owner April 18, 2026 03:36
@cheeseng
cheeseng force-pushed the scaladoc-tags-collection-immutable branch from e9933ab to 87b5216 Compare April 20, 2026 06:20
@SolalPirelli
SolalPirelli merged commit d9b4251 into scala:main Apr 28, 2026
45 checks passed
mbovel pushed a commit to mbovel/dotty that referenced this pull request May 4, 2026
…tags in Scaladoc comments (scala#25373)

As a next step in improving the Scaladoc documentation for the Scala 3
standard library, this PR fills in missing @param, @tparam, and @return
tags for collection immutable.
@WojciechMazur WojciechMazur added this to the 3.9.0 milestone May 26, 2026
bishabosha pushed a commit to dotty-staging/dotty that referenced this pull request Jun 5, 2026
…tags in Scaladoc comments (scala#25373)

As a next step in improving the Scaladoc documentation for the Scala 3
standard library, this PR fills in missing @param, @tparam, and @return
tags for collection immutable.
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.

6 participants