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

Change some type annotation in YARD doc #1175

Merged
merged 1 commit into from Aug 11, 2018

Conversation

gmalette
Copy link
Contributor

@gmalette gmalette commented Jul 4, 2018

Description

Some of the type annotations in the documentation referrenced types that
were not in scope for the annotation. This means that a compiler
generating the doc could incorrectly associate the constants with
another type which would be in scope.

Completed Tasks

  • I have read the Contributing Guide.
  • The pull request is complete (implemented / written).
  • Git commits have been cleaned up (squash WIP / revert commits).
  • [ ] I wrote tests and ran bundle exec rake locally (if code is attached to PR). (no code)

Some of the type annotations in the documentation referrenced types that
were not in scope for the annotation. This means that a compiler
generating the doc could incorrectly associate the constants with
another type which would be in scope.
@@ -181,7 +181,7 @@ def inherited(subclass)
# the handlers, otherwise the same code will be parsed
# multiple times and slow YARD down.
#
# @param [Parser::RubyToken, Symbol, String, Regexp] matches
# @param [Parser::Ruby::Legacy::RubyToken, Symbol, String, Regexp] matches
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% certain this is the right one, but it's the only RubyToken I could find in this gem.

@coveralls
Copy link

coveralls commented Jul 4, 2018

Coverage Status

Coverage increased (+1.0%) to 94.56% when pulling 9f8bfba on gmalette:gm/change-annotations-for-scoping into 44ca65d on lsegal:master.

@lsegal lsegal merged commit 61c1665 into lsegal:master Aug 11, 2018
@lsegal
Copy link
Owner

lsegal commented Aug 11, 2018

That's the right one, thanks!

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

Successfully merging this pull request may close these issues.

None yet

3 participants