Fill in missing @param, @tparam, and @return tags in Scaladoc comments.#25268
Draft
bvenners wants to merge 1 commit intoscala:mainfrom
Draft
Fill in missing @param, @tparam, and @return tags in Scaladoc comments.#25268bvenners wants to merge 1 commit intoscala:mainfrom
bvenners wants to merge 1 commit intoscala:mainfrom
Conversation
bvenners
force-pushed
the
feature-fill-in-missing-param-tparam-return-tags
branch
2 times, most recently
from
fef4048 to
c9543f1
Compare
Contributor
Author
|
I just pushed changes to fix the build errors, but squashed them into a single commit. Once I see that it passes all the tests I'll sit down and look through everything! I'll un-draft it only after I've reviewed everything. We still need humans. For now. |
…s for the standard library
bvenners
force-pushed
the
feature-fill-in-missing-param-tparam-return-tags
branch
from
c9543f1 to
a70bf1f
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
1 participant
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 missing @param, @tparam, and @return tags. I'm submitting it as a draft PR so that I can get the CI to run on it, to see if it breaks anything, and to start getting feedback. I automated the generation of these changes and have not reviewed all of them yet. I will review them all before making the PR non-draft. Please let me know whether you think this is going in the right direction in general, and anything specific that you notice that could be improved.