zulip-terminal
zulip-terminal copied to clipboard
Group narrowing commands and improve descriptions
What does this PR do, and why?
- Groups commands that switch narrows
- Improves their help descriptions
Outstanding aspect(s)
Feedback on the following are needed:
- name of the chosen help category
- order of the commands within the narrowing category
- help descriptions
External discussion & connections
- [x] Discussed in #zulip-terminal in
re-categorization - [ ] Fully fixes #
- [ ] Partially fixes issue #
- [ ] Builds upon previous unmerged work in PR #
- [ ] Is a follow-up to work in PR #
- [ ] Requires merge of PR #
- [ ] Merge will enable work on #
How did you test this?
- [ ] Manually - Behavioral changes
- [x] Manually - Visual changes
- [ ] Adapting existing automated tests
- [ ] Adding automated tests for new behavior (or missing tests)
- [x] Existing automated tests should already cover this (only a refactor of tested code)
Self-review checklist for each commit
- [x] It is a minimal coherent idea
- [x] It has a commit summary following the documented style (title & body)
- [x] It has a commit summary describing the motivation and reasoning for the change
- [x] It individually passes linting and tests
- [ ] It contains test additions for any new behavior
- [x] It flows clearly from a previous branch commit, and/or prepares for the next commit
Visual changes
I've made the following changes:
1st commit
- [x] Re-ordered to
s,S,z,Meta . - [x] User-facing category name: "Switch message view" -> "Switching messages view"
- [x] Internal category name: "narrow" -> "narrowing"
2nd commit
- [x] The previous PR version used "Go to", this version uses "View" and "View all". Please refer to the commit description for details.
Follow-ups to address in separate commits / PRs:
- All Messages -> Combined Feed everywhere
- All DMs -> your DM feed or equivalent
- Replace "narrow" with "message view" or others in user-facing documentation like the user tutorial.
- Consider casefix changes to parts of the UI like - All Messages and Direct Messages I didn't do this as part of the 2nd commit because it makes sense grammatically, without marking them as proper nouns. We could do that when we start using "Feed" terminology?
- Add a new key binding mentioning that 'Enter' activates narrowing buttons
I don't see this help text properly fitting in any category that we have at the moment, and general is just too broad.
We could instead not add this to a category, but just add it to a context, following the discussions in CZO topics
Restructure Key Bindings?andSupporting Help Multi-categories #T1519. We have the ACTIVATE_BUTTON key binding at the moment. - I've used a mention of 'PM' in the help text. I know that we ideally want to use DMs and key it in with ZFL, but hopefully we can handle that as a follow-up PR too, as we're currently using PM everywhere in the code base.
- Return to
n&plater after fine-tuning the View/Narrow/Navigate nuances.
Please let me know if I've missed anything or misunderstood something, @neiljp.
Note: The "Narrow to compose box message recipient" command that we just assigned to category "compose_box" in #1520 is now re-assigned to category "narrowing". Comparing the 2 categories, I think the "narrowing" category is a better fit, as the compose box relation can be covered with the contextual help when added.
@Niloth-p Thanks for the rebase :+1: I agree about the narrowing category, certainly until we consider multi-categories (if we do).
It would seem that n/p would also be best in this same category for now? That is, compared to others that will be present in the short term?
The meta . change has issues:
- it changes to any conversation, not just DMs/PMs
- if it was DMs/PMs only, the UI itself should all be expressed as 'Direct' by now
- 'Open PM' reads strangely to me, but given the above it can be changed in any case
I believe those were the two points I had noticed and was starting to work through before you pushed again this evening :)
-
Grouped 'p' and 'n' into the 'narrowing' category.
-
Oops, thank you! I've rephrased it to "Switch message view to the compose box target". I felt 'recipient' could be made a bit more user-friendly.
-
I noticed that I had somehow had missed the re-ordering changes while rebasing on merges, at some point of time. So, I created a separate commit for that and kept it in the middle, so that it can be squashed into either the first or the last, if necessary.
-
Updated the commit descriptions.
@Niloth-p Thanks for the update 👍 I partially reversed the mentions text, but that's a marginal language change, and otherwise I just tweaked the commit text.
The middle commit is small, but helps keep the reordering clear, since the diff is less clear otherwise, so I've left it separate :+1:
Merging this now, thanks all! :tada:
I've added the follow-up points you noted above as a summary into the bottom of #1524 to keep them tracked, as well as a few other points.