misc, root (2): Add Scaladoc comments for undocumented entities - #26657
Open
bvenners wants to merge 1 commit into
Open
misc, root (2): Add Scaladoc comments for undocumented entities#26657bvenners wants to merge 1 commit into
bvenners wants to merge 1 commit into
Conversation
bvenners
changed the title
cheeseng
suggested changes
Jul 30, 2026
cheeseng
left a comment
cheeseng
left a comment
Contributor
There was a problem hiding this comment.
Added some comments, with one that explicitly stated NEEDS-HUMAN as a note that we shall look into.
bvenners
force-pushed
the
scaladoc-missing-docs-misc-dirs-root-misc
branch
from
July 31, 2026 00:51
275a255 to
800702c
Compare
bvenners
force-pushed
the
scaladoc-missing-docs-misc-dirs-root-misc
branch
from
July 31, 2026 03:45
efef4f5 to
0b79be4
Compare
bvenners
marked this pull request as ready for review
July 31, 2026 03:46
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.
This PR fills in a main doc comment plus @PARAM, @tparam, and @return tags for misc and root classes that are completely missing any Scaladoc documentation. 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. We automated the generation of these changes and have not reviewed all of them yet. We 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.