Add hover documentation for reserved keywords #3553
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
How to use the Graphite Merge QueueAdd the label graphite-merge to this PR to add it to the merge queue. You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
mikeygough
added
enhancement
mikeygough
force-pushed
the
add-hover-documentation-for-keywords
branch
3 times, most recently
from
adb884e to
0acb5f9
Compare
vinistock
reviewed
May 29, 2025
mikeygough
force-pushed
the
add-hover-documentation-for-keywords
branch
from
3ae4d4c to
ab082e3
Compare
mikeygough
changed the title
mikeygough
force-pushed
the
add-hover-documentation-for-keywords
branch
from
ab082e3 to
aaa27d3
Compare
mikeygough
force-pushed
the
add-hover-documentation-for-keywords
branch
from
aaa27d3 to
ae11a22
Compare
mikeygough
force-pushed
the
add-hover-documentation-for-keywords
branch
2 times, most recently
from
f0d252e to
cd2f5bc
Compare
mikeygough
force-pushed
the
add-hover-documentation-for-keywords
branch
from
cd2f5bc to
847ba97
Compare
mikeygough
force-pushed
the
add-hover-documentation-for-keywords
branch
from
a9f9809 to
c7d8d1e
Compare
|
This pull request is being marked as stale because there was no activity in the last 2 months |
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.
Partially closes #2227
This PR adds hover documentation for the following Ruby reserved keywords:
breakcaseclassdefdefined?elseensureformodulenextrescuereturnundefunlessuntilwhenwhileruby-keyword-hover-documentation-demo.mov
This documentation was written by AI following Shopify's Ruby style guide. It has been reviewed by myself but would appreciate additional, more experienced eyes!
NOTE - The following keywords still need definitions which may require modifying their associated
Prism Node:aliasandbegindoelsifendfalseifinnillnotorredoretryselfsuperthentrueMotivation
We can deliver a better Ruby programming experience if developers can hover over built-in keywords to learn more about how they work!
Implementation
This implementation follows a pattern established by the
yieldkeyword. It adds a key value pair to theKEYWORD_DOCS' hash insidestatic_docs.rb, writes a keyword specific markdown file that goes into a deeper explanation and extendshover.rb` to handle keyword specific hover events.Automated Tests
Run
dev tManual Tests
Start the Ruby LSP. Use some keywords and checkout the tooltips + related documentation!