Allow literal symbols in types #1622
Open
+21
−6
Conversation
This file contains hidden or 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 matches behavior of https://yardoc.org/types. Literal symbols are also supported by RBS, sord and recent versions of Solargraph, so this also reduces interoperability friction between tools.
lsegal
reviewed
Dec 5, 2025
lib/yard/code_objects/base.rb
Outdated
Comment on lines
60
to
63
| # Regular expression to match an identifier like a variable or method name | ||
| IDENTIFIERMATCH = %r{[a-zA-Z_]\w*[!?=]?|[-+~]\@|<<|>>|=~|===?|![=~]?|<=>|[<>]=?|\*\*|[-/+%^&*~`|]|\[\]=?} | ||
|
|
||
| METHODNAMEMATCH = IDENTIFIERMATCH |
Owner
There was a problem hiding this comment.
This changes documentation (unnecessarily). I would just use METHODNAMEMATCH in types_explainer.
4 tasks
Contributor
Author
Fixed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
This matches behavior of https://yardoc.org/types. Literal symbols are also supported by RBS, sord and recent versions of Solargraph, so this also reduces interoperability friction between tools.
For instance, valid Solargraph annotations will cause errors in rubocop-yard, which uses YARD for parsing:
Completed Tasks
bundle exec rakelocally (if code is attached to PR).