Handle invalid option tag with name only #1481
Open
+11
−0
Conversation
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
|
I think "gracefully" would require at least a warning for the invalid tags. |
lsegal
requested changes
Apr 8, 2023
lib/yard/tags/default_factory.rb
Outdated
| @@ -73,6 +73,9 @@ def parse_tag_with_title_and_text(tag_name, text) | |||
| end | |||
|
|
|||
| def parse_tag_with_types_name_and_default(tag_name, text) | |||
| if text.nil? | |||
| return nil | |||
There was a problem hiding this comment.
- I would expect to see a warning being generated either here or somewhere in this code path.
- You can
returninstead ofreturn nil - I would recommend adding a newline of space after the
endof this block (code style aesthetic)
lsegal
reviewed
Apr 8, 2023
spec/tags/default_factory_spec.rb
Outdated
| @@ -164,5 +164,10 @@ def parse_options(text) | |||
| expect(t.pair).to be_instance_of(Tags::DefaultTag) | |||
| expect(t.pair.name).to eq "key" | |||
| end | |||
|
|
|||
| it "allows name only" do | |||
There was a problem hiding this comment.
Realistically this test should be more descriptive-- technically these aren't "allowed".
We have some of these in our codebase: ``` @option :foo ``` Handle them gracefully, even though they are invalid.
naveg
force-pushed
the
invalid-option-tag
branch
from
b7cb165
to
1d79952
Compare
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.
We have some of these in our codebase:
Handle them gracefully, even though they are invalid.
These were causing errors in VSCode, via Solargraph:
Completed Tasks
bundle exec rakelocally (if code is attached to PR).