Document fewer useless methods/classes #3908
Merged
Conversation
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
When generating docs in ruby/prism, this doesn't seem to matter. But on docs.ruby-lang.org these take over the actual documentation.
They don't tell much of a story and just pull attention away from actually unique methods
As well as some functionality from ripper that is nodoc in ruby
These result in so many methods that are searchable and give no actual benefit. Toplevel docs are all you need to understand the usecase.
Earlopain
force-pushed
the
document-less
branch
from
5ce4a5d to
f1b1dc3
Compare
kddnewton
approved these changes
Feb 6, 2026
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Feb 6, 2026
(ruby/prism#3908) * Add missing nodocs for FFI When generating docs in ruby/prism, this doesn't seem to matter. But on docs.ruby-lang.org these take over the actual documentation. * Nodoc various utility methods They don't tell much of a story and just pull attention away from actually unique methods * Nodoc some private functions/modules * Nodoc translator implementation details As well as some functionality from ripper that is nodoc in ruby * Stop documenting visitor implementation details These result in so many methods that are searchable and give no actual benefit. Toplevel docs are all you need to understand the usecase. ruby/prism@0bd9a7d373
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 aims to stop poluting the docs with so many useless functions and removes some docs that should not be visible. A few examples:
Prism::Serializeisprivate_constantbut still shown in docsPrism::VisitoronlyOn https://docs.ruby-lang.org/en/master/Prism.html, FFI docs overtake the real docs. I can't reproduce this with just the prism docs but
nodocing the rest that was missed should probably do it.I made a handful of commits and their rational but overall this should be squash merged.