Root files (9): filled in @param, @tparam, and @return tags that were missed last time#26125
Draft
bvenners wants to merge 1 commit into
Draft
Root files (9): filled in @param, @tparam, and @return tags that were missed last time#26125bvenners 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.
| * @param n3 the number of elements in the 3rd dimension | ||
| * @param n4 the number of elements in the 4th dimension | ||
| * @param n5 the number of elements in the 5th dimension | ||
| * @return a new `Array[Array[Array[Array[Array[T]]]]]` of size `n1 x n2 x n3 x n4 x n5`, with all elements initialized to their default value |
Contributor
There was a problem hiding this comment.
I think this and its friends before this is inconsistent with the next and others, which mentions the number of dimensional, I think we shall make them consistent.
| * @param n3 the number of elements in the 3rd dimension | ||
| * @param n4 the number of elements in the 4th dimension | ||
| * @param n5 the number of elements in the 5th dimension | ||
| * @return a new `Array[Array[Array[Array[Array[T]]]]]` of dimensions `n1 x n2 x n3 x n4 x n5` with all innermost `T` elements set to the default value for `T` |
Contributor
There was a problem hiding this comment.
Same issue like Array.scala in library-js, I think we should be consistent with message like:
a edit-dimensional Array[Array[Array[Array[Array[T]]]]] of dimensions n1 x n2 x n3 x n4 x n5 ...
…(Array, IArray, Option, Predef, Function, Tuple, MatchError, and numeric types) (cleanup follow-up)
cheeseng
force-pushed
the
scaladoc-tags-root-files-cleanup
branch
from
3fbabbd to
2772db3
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 for the loose root files (Array,IArray,Option,Predef,Function,Tuple,MatchError, and numeric types) that 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.