Skip to content
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

:stopdoc: can prevent indexing a class documented in another file #398

Open
halostatue opened this issue Mar 15, 2016 · 1 comment
Open
Labels

Comments

@halostatue
Copy link

When working on cartage 2.0, I found a case where the improper placement of the :stopdoc: directive can prevent the indexing of a class documented in another file. I have created a minimal reproduction and workaround as a gist.

My specific use-case was that I have a file that implements #dig for RUBY_VERSION < '2.3'. I don’t want any of that documented because its presence is incidental to the main gem.

Funnily enough, this may be related to the fix in #55 mentioned in the guidelines for contributing.

@zzak zzak added the bug label Mar 23, 2016
@nobu
Copy link
Member

nobu commented Oct 27, 2018

Probably I encountered this bug while generating ruby's NEWS.html, and made a workaround.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

No branches or pull requests

3 participants