Fix error when @option
with non-method
#1508
Merged
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.
Description
Applying the
@option
tag to non-method code results in an error during documentation generation.I have fixed it to prevent the error from occurring.
It might be acceptable to log a warning message, but for now, I've adjusted it to match the current behavior of the
@param
tag, which displays nothing.Completed Tasks
bundle exec rake
locally (if code is attached to PR).