-
-
Notifications
You must be signed in to change notification settings - Fork 399
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
Fix double return tag. #1226
Merged
Merged
Fix double return tag. #1226
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# frozen_string_literal: true | ||
|
||
module YARD::Handlers | ||
module Common | ||
# Shared functionality between Ruby and C method handlers. | ||
module MethodHandler | ||
# @param [MethodObject] obj | ||
def add_predicate_return_tag(obj) | ||
if obj.tag(:return) && (obj.tag(:return).types || []).empty? | ||
obj.tag(:return).types = ['Boolean'] | ||
elsif obj.tag(:return).nil? | ||
unless obj.tags(:overload).any? {|overload| overload.tag(:return) } | ||
obj.add_tag(YARD::Tags::Tag.new(:return, "", "Boolean")) | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -213,6 +213,7 @@ | |
foo = Registry.at('Foo#foo?') | ||
expect(foo.docstring).to eq 'DOCSTRING' | ||
expect(foo.tag(:return).types).to eq ['Boolean'] | ||
expect(foo.tags(:return).size).to eq 1 | ||
end | ||
|
||
it "does not add return tag if return tags exist" do | ||
|
@@ -226,6 +227,7 @@ | |
eof | ||
foo = Registry.at('Foo#foo?') | ||
expect(foo.tag(:return).types).to eq ['String'] | ||
expect(foo.tags(:return).size).to eq 1 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is the test that catches the bug. I can dig deeper into why the other test didn't raise any errors before the fix. |
||
end | ||
|
||
it "handles casted method names" do | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Without the fix to
handler_methods.rb
this test still passed. And I don't quite understand why. I would have expected this to yield 2 and fail when YARD added an extra@return
tag.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are no extra tags on the method defined in this specific test, which would explain why the result hasn't changed.