Util, io, ref (8): filled in @param, @tparam, and @return tags that were missed last time#26127
Draft
bvenners wants to merge 1 commit into
Draft
Util, io, ref (8): filled in @param, @tparam, and @return tags that were missed last time#26127bvenners wants to merge 1 commit into
bvenners wants to merge 1 commit into
Conversation
cheeseng
suggested changes
May 22, 2026
Contributor
cheeseng
left a comment
cheeseng
left a comment
There was a problem hiding this comment.
Added some suggestions.
| /** Returns the line number of the encoded position. | ||
| * | ||
| * @param pos the encoded position as returned by `encode` | ||
| * @return the 1-based line number extracted from `pos`, or 0 if the line is undefined |
Contributor
There was a problem hiding this comment.
Since we use encode function, I think we should say 'decoded here instead of 'extracted.
| /** Returns the column number of the encoded position. | ||
| * | ||
| * @param pos the encoded position as returned by `encode` | ||
| * @return the 1-based column number extracted from `pos`, or 0 if the column is undefined |
Contributor
There was a problem hiding this comment.
Since we use encode function, I think we should say 'decoded here instead of 'extracted.
| * | ||
| * @param minInclusive the lower bound (inclusive) of the range | ||
| * @param maxExclusive the upper bound (exclusive) of the range, must be greater than `minInclusive` | ||
| * @return a pseudorandom `Long` in the range `[minInclusive, maxExclusive)` |
Contributor
There was a problem hiding this comment.
The closing bracket ) after the maxExclusive should be ]
….io, scala.ref (cleanup follow-up)
cheeseng
force-pushed
the
scaladoc-tags-util-io-ref-cleanup
branch
from
4580d88 to
249e26f
Compare
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.util,scala.io, andscala.refthat 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.