Collection mutable (2): filled in @param, @tparam, and @return tags that were missed last time#26120
Draft
bvenners wants to merge 1 commit into
Draft
Conversation
…mutable (cleanup follow-up)
cheeseng
suggested changes
May 21, 2026
| * exception if no other default behavior was specified. | ||
| * | ||
| * @param key the key to look up a default value for | ||
| * @return the default value supplied by `defaultEntry` for `key`, or throws if no `defaultEntry` was provided |
Contributor
There was a problem hiding this comment.
It will be better if the type of the error/exception being thrown is specified.
| * @param maxItems | ||
| */ | ||
| /** This is a more general version of copyToArray - this also accepts a srcStart unlike copyToArray | ||
| * This copies maxItems elements from this collections srcStart to dest's destStart |
Contributor
There was a problem hiding this comment.
should be:
... this collection's
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
2 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.