Collection mutable (2): filled in @param, @tparam, and @return tags that were missed last time#26120
Open
bvenners wants to merge 1 commit into
Open
Conversation
cheeseng
suggested changes
May 21, 2026
bvenners
force-pushed
the
scaladoc-tags-collection-mutable-cleanup
branch
2 times, most recently
from
4054f13 to
74bb7d4
Compare
…mutable (cleanup follow-up)
bvenners
force-pushed
the
scaladoc-tags-collection-mutable-cleanup
branch
from
74bb7d4 to
ef8c7ed
Compare
SethTisue
reviewed
Jun 2, 2026
| /** Implementation of `make` for JS. | ||
| * | ||
| * @tparam T the element type of the array builder, with a `ClassTag` context bound | ||
| * @return a new generic `ArrayBuilder` optimized for Scala.js |
| * See trimToSize if you want to also resize internally | ||
| * | ||
| * @param index the zero-based position of the first element to remove | ||
| * @param count the number of elements to remove; a negative value throws `IllegalArgumentException` |
Member
There was a problem hiding this comment.
are we missing a @throws, then?
| */ | ||
| /** This is a more general version of copyToArray - this also accepts a srcStart unlike copyToArray | ||
| * This copies maxItems elements from this collection's srcStart to dest's destStart | ||
| * If we reach the end of either collections before we could copy maxItems, we simply stop copying |
Member
There was a problem hiding this comment.
Suggested change
| * If we reach the end of either collections before we could copy maxItems, we simply stop copying | |
| * If we reach the end of either collection before we could copy maxItems, we simply stop copying |
| * @tparam V the type of the values associated with the keys | ||
| * @param initialCapacity the initial capacity of the internal hash table | ||
| * @param loadFactor the load factor for the hash table, used to determine when to resize | ||
| * @param ordering the `Ordering` used to compare keys within a bucket's red-black tree |
Member
There was a problem hiding this comment.
does it make sense to mention the red-black tree, or is that just an implementation detail?
| /** Computes the improved hash of an original (`any.##`) hash. | ||
| * | ||
| * @param originalHash the original hash code from `any.##` | ||
| * @return the improved hash with the high 16 bits xored into the low 16 bits |
Member
There was a problem hiding this comment.
consistency: xor vs XOR (I think I prefer XOR, but regardless, it should be consistent)
| * | ||
| * @param index the index to modify. | ||
| * @param ch the new Char. | ||
| * @return this StringBuilder. |
Member
There was a problem hiding this comment.
Suggested change
| * @return this StringBuilder. | |
| * @return this `StringBuilder`. |
| /** Overloaded version of `addAll` that takes a string. | ||
| * | ||
| * @param s the string to append to this builder | ||
| * @return this StringBuilder |
Member
There was a problem hiding this comment.
Suggested change
| * @return this StringBuilder | |
| * @return this `StringBuilder` |
Contributor
Author
|
@SethTisue Great comments. I'll check into them. |
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
3 participants
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.
As a next step in improving the Scaladoc documentation for the Scala 3 standard library, this PR fills in
@param,@tparam, and@returntags forscala.collection.mutablethat were missed in the previous batch of PRs. I'm submitting it as a draft PR so to get CI to run on it, to see if it breaks anything, and to start getting feedback. We automated the generation of these changes and are starting to review them. We will review them all before making the PR non-draft. Please let me know if you see anything specific that you think could be improved.