-
-
Notifications
You must be signed in to change notification settings - Fork 397
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
Private tag (# @private) no longer working correctly #1170
Comments
Looks like a regression in symbol parsing (via #1168) is causing symbols to incorrectly parse and probably leading to the full Ruby file parsing incorrectly too. I will look into this. |
The regression was specific to symbols that used Ruby keywords as their symbol content, which was probably only affecting your JSON module. This will be fixed and a hotfix version pushed shortly. |
Thanks so much @lsegal |
This was referenced Mar 12, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hi, it seems the private tag (
# @private
) has stopped working for an inherited class on0.9.13
, we use this on RSpec to help us hide / ignore files that are internal workings not intended for direct manipulation, we also have a lint check enforcing we have 100% of our public API documented, since0.9.13
this is now failing, see example: https://travis-ci.org/rspec/rspec-core/jobs/385051942 and the file in question: https://github.com/rspec/rspec-core/blob/7b6b9c3f2e2878213f97d6fc9e9eb23c323cfe1c/lib/rspec/core/formatters/json_formatter.rbSteps to reproduce
Run
bin/yard stats --list-undoc
orbin/yard stats --list-undoc --no-private
againstrspec-core
, see that file is incorrectly marked as undocumented.Actual Output
Expected Output
Environment details:
yard -v
): 0.9.13The text was updated successfully, but these errors were encountered: