-
-
Notifications
You must be signed in to change notification settings - Fork 278
Break down the GO_BACK command into separate commands #1514
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Hello @zulip/server-refactoring members, this pull request was labeled with the "area: refactoring" label, so you may want to check it out! |
bbd7b2e
to
d449a0d
Compare
'CLEAR_SEARCH': { | ||
'keys': ['esc'], | ||
'help_text': 'Clear search in current panel', | ||
'key_category': 'searching', | ||
}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we're aiming at contextual help messages, should we be using the word panel
? It feels more like code terminology and might not be useful as a help message.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm.
Found mentions of 'panel' in the user facing documentation.
What other word do you think would fit better in this context?
Edit: As discussed, it's hard to come up with suitable alternatives, so I've left it as 'panel'.
LGTM! The intention seems clear since we're aiming for contextual help. Just a note: Either this PR or #1442 will need to handle conflicts in a rebase, depending on which gets merged first. |
d449a0d
to
02f3c98
Compare
02f3c98
to
0605a95
Compare
0605a95
to
d0a086c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is pretty nicely structure and looks good to me. Thank you!
Tests updated. Hotkeys document regenerated.
Added an exclusion in lint-hotkeys for `Esc` as both EXIT_POPUP and ALL_MESSAGES commands belong to the help category 'Navigation'. Tests updated. Hotkeys document regenerated.
Tests updated. Hotkeys document regenerated.
d0a086c
to
97e8e20
Compare
@Niloth-p I agree with @zormit - this is clear and easy to read 👍 The changes I pushed back with were only structural/text (the code overall is identical):
|
What does this PR do, and why?
Breaks GO_BACK command into the following commands:
This would enable using more specific help texts, categories and context.
And clarifies the purposes of the key better for users and developers.
I've kept these as separate commits for the sake of readability. Introducing each command in its own commit, then finally removing GO_BACK command.
I could break #1497 into commits similar to this one for readability, if necessary.
I've kept this as a separate PR as it's an independent change, even though the motivation is shared.
External discussion & connections
re-categorize
How did you test this?
Self-review checklist for each commit