-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for :showdoc: directive for private and protected objects (RFC #0011) #15337
base: master
Are you sure you want to change the base?
Add support for :showdoc: directive for private and protected objects (RFC #0011) #15337
Conversation
I've just been thinking of an edge case: we need the parent namespace to appear if any descendant type is marked with # :nodoc:
#
# this comment musn't appear in docs
module Foo
# :showdoc:
#
# this comment must appear in docs
module Bar
end
end |
@ysbaddaden I believe the nodoc nesting showdoc case should be handled because But this concern brings up that there should be specs for this to ensure the behaviour is implemented as inspected and won't change by future changes. |
@ysbaddaden I believe the behavior determined during discussion with the RFC is that a @straight-shoota I can work on adding doc generator specs. |
Let me know if you have more ideas for specs |
This pull request has been mentioned on Crystal Forum. There might be relevant details there: |
Using :showdoc: on a namespace does not apply to child methods / objects
First part of splitting up #15294.
Private class:
Private methods: