Add hover documentation for 'break' keyword #3587
Merged
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
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.
Step towards #2227
This PR adds hover documentation for the 'break' keyword by following a pattern established by hover documentation for the 'yield' keyword.
This keyword documentation was written by AI following Shopify's Ruby style guide. It has been reviewed by myself but could benefit from additional reviews!
Motivation
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 the keyword and checkout the tooltip + related documentation!