Drop :nodoc: options from core classes that contains methods with docs
#322
+2
−2
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
Member
Author
|
Oops I should have read this ticket. But still believe having the docs is better. https://bugs.ruby-lang.org/issues/6880 |
soutaro
changed the title
:nodoc: options from that contains methods with docs:nodoc: options from core classes that contains methods with docs
Member
|
Thanks. I don't have a strong opinion for this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I found some methods are not included in RDoc output, and the
:nodoc:option should be the reason.It seems like there is no reason to opt-out the methods. 7b79bec added the option, but still not clear why we needed it.