refactor(shortcuts): Improve shortcut registry documentation & style #8598
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
Make some minor refactorings of shortcut_registry.ts to improve readability and style, and add documentation for the KeyboardShortcut interface type.
rachel-fenichel
requested changes
Sep 30, 2024
|
@rachel-fenichel: You are a spelling-error-detecting machine—and evidently I need to figure out how to get emacs to give me wavy red underlines… |
rachel-fenichel
approved these changes
Oct 1, 2024
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.
The basics
The details
Proposed Changes
Make some minor refactorings of
shortcut_registry.tsto improve readability and style, and add documentation for theKeyboardShortcutinterface type.Reason for Changes
It was a bit harder than necessary to grok how this worked (ideally one should not need to read the source code!), so trying to make it easier for others / future self.
Test Coverage
Passes
npm test+ quick manual verification that shortcuts still work.Documentation
Improved, hopefully.