Collection immutable (3): filled in @param, @tparam, and @return tags that were missed last time#26121
Draft
bvenners wants to merge 1 commit into
Draft
Conversation
…immutable (cleanup follow-up)
cheeseng
suggested changes
May 21, 2026
| * | ||
| * @param start the first value of the new range | ||
| * @param end the upper bound of the new range (inclusive or exclusive, matching the original range) | ||
| * @param end the end boundary of the new range (inclusive or exclusive, matching this range) |
Contributor
There was a problem hiding this comment.
I think the wording should be consistent with start, if we use 'first value' for start then we should use 'last value' for end, if we use 'end boundary' for end, then I think we should use 'start boundary' for start.
| * | ||
| * @tparam A the element type of the lazy list | ||
| * @param state the by-name expression computing the initial state of the lazy list | ||
| * @param state the by-name expression that, when forced, produces the lazy list |
Contributor
There was a problem hiding this comment.
To be honest I have never seen the use of word 'forced' on by-name, not sure if it is right?
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.immutablethat 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.