Skip to content
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

Add multi-category support for key bindings. #1519

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Niloth-p
Copy link
Collaborator

@Niloth-p Niloth-p commented Jun 15, 2024

What does this PR do, and why?

Break the restriction that a hotkey can only belong to a single category, allowing a hotkey to be displayed in multiple relevant sections of the help menu.

Outstanding aspect(s)

This does not currently use the new infrastructure to update particular key bindings assigning them to multiple categories.
Because they depend on the newer categories that are being created in prior PRs.

Further discussion required on the amount of duplication that would be acceptable in the help menu, and whether to only include entries in their type-based categories, or in both type-based as well as context-based categories.

External discussion & connections

  • Discussed in #zulip-terminal in topic
  • 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
  • Manually - Visual changes
  • Adapting existing automated tests
  • Adding automated tests for new behavior (or missing tests)
  • Existing automated tests should already cover this (only a refactor of tested code)

Self-review checklist for each commit

  • It is a minimal coherent idea
  • It has a commit summary following the documented style (title & body)
  • It has a commit summary describing the motivation and reasoning for the change
  • It individually passes linting and tests
  • It contains test additions for any new behavior
  • It flows clearly from a previous branch commit, and/or prepares for the next commit

To break the restriction that a hotkey can only belong to a single
category, allowing a hotkey to be displayed in multiple relevant
sections of the help menu.

Linting and tests updated.
@zulipbot zulipbot added the size: XL [Automatic label added by zulipbot] label Jun 15, 2024
@Niloth-p Niloth-p marked this pull request as draft June 15, 2024 06:30
@zulipbot
Copy link
Member

Hello @zulip/server-hotkeys members, this pull request was labeled with the "area: hotkeys" label, so you may want to check it out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: hotkeys area: popup: help further discussion required Discuss this on #zulip-terminal on chat.zulip.org size: XL [Automatic label added by zulipbot]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants