Sys, concurrent, runtime (1): filled in @param, @tparam, and @return tags that were missed last time#26119
Draft
bvenners wants to merge 1 commit into
Draft
Conversation
…concurrent, scala.runtime (cleanup follow-up)
cheeseng
suggested changes
May 21, 2026
Contributor
cheeseng
left a comment
cheeseng
left a comment
There was a problem hiding this comment.
Some suggestions to improve.
| * | ||
| * @param p the predicate to apply to the successful result of this `Future` | ||
| * @param executor the `ExecutionContext` on which the predicate will be executed | ||
| * @return a `Future` which will hold the successful result of this `Future` if it matches the predicate or a `NoSuchElementException` |
Contributor
There was a problem hiding this comment.
For the second part of the sentence, may be something like this is clearer:
... or a Future in failed state with NoSuchElementException
| * @param op the fold operation to be applied to the zero and futures | ||
| * @return the `Future` holding the result of the fold | ||
| * | ||
| * @param executor the `ExecutionContext` on which the fold operation will be executed |
Contributor
There was a problem hiding this comment.
I think will be good to be before the @return .
| * @param op the reduce operation which is applied to the results of the futures | ||
| * @return the `Future` holding the result of the reduce | ||
| * | ||
| * @param executor the `ExecutionContext` on which the reduce operation will be executed |
Contributor
There was a problem hiding this comment.
It will be better if it is before the @return ?
| * @param fn the function to be mapped over the collection to produce a collection of Futures | ||
| * @return the `Future` of the collection of results | ||
| * | ||
| * @param bf the `BuildFrom` used to construct the resulting collection `M[B]` from the values of type `B` |
| * It never returns negative results. | ||
| * | ||
| * @param timeout the maximum time to wait, in milliseconds | ||
| * @return the elapsed wait time in milliseconds, or `0` if `timeout <= 0` or the elapsed time was negative |
Contributor
There was a problem hiding this comment.
This part:
or the elapsed time was negative
is a bit confusing, the original comment of 'never returns negative results' should be better.
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.sys,scala.concurrent, andscala.runtimethat 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.