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

Superfluous return type in methods ending in ? #41

Closed
dduugg opened this issue May 22, 2021 · 0 comments · Fixed by #42
Closed

Superfluous return type in methods ending in ? #41

dduugg opened this issue May 22, 2021 · 0 comments · Fixed by #42
Assignees
Labels
bug Something isn't working

Comments

@dduugg
Copy link
Owner

dduugg commented May 22, 2021

This can be reproduced by viewing the documentation for SigHandler#processable_method? on the repo itself:
image

This is due to yard adding a Boolean return type to methods that end in ?:
https://github.com/lsegal/yard/blob/b589fa0/lib/yard/handlers/ruby/method_handler.rb#L42-L43
https://github.com/lsegal/yard/blob/b589fa0/lib/yard/handlers/common/method_handler.rb#L8

This is redundant in the best case, but can also result in incorrect documentation in instances where the return type is not a Boolean (a bad practice for such method names, but something we should still allow overriding).

@dduugg dduugg added bug Something isn't working good first issue Good for newcomers labels May 22, 2021
@dduugg dduugg removed the good first issue Good for newcomers label May 24, 2021
@dduugg dduugg self-assigned this May 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant