Label Rspec as @private for docs, update other modules visibility #1479
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
|
See lsegal/yard#906 |
JonRowe
force-pushed
the
label_Rspec_as_private
branch
from
39cf201 to
2620823
Compare
|
Ok, so it turns out YARD wasn't responsible for this entirely, our modules are actually mislabeled on master so we can just hide lowercase |
JonRowe
changed the title
|
If this fixes the doc issue, LGTM. |
|
@myronmarston it does for me with |
Have you tried generating the docs for rspec.info, though? Would be nice to see it work for that since that's a different process. |
A lot of these modules are for public use, but were being mislabled as private for some reason, this prevents that by explicity labelling those with normal comments as @api public, and thus their method are restored too.
JonRowe
force-pushed
the
label_Rspec_as_private
branch
from
2620823 to
4a2a078
Compare
|
Am I ok to merge this? I'd like to cherry pick it back to 3-3 so I can test doc regeneration |
|
Merge away. |
JonRowe
added a commit
that referenced
this pull request
Oct 25, 2015
Label Rspec as @Private for docs, update other modules visibility
JonRowe
added a commit
that referenced
this pull request
Oct 25, 2015
Label Rspec as @Private for docs, update other modules visibility
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.
This should remove the broken documentation links, which it does but it also labels everything under
RSpecas private :/ This is for rspec/rspec.github.io#50...