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.

Sign up for GitHub

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

fix(docs): correct default 'opts.triggers' modes in README trigger section #872

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −3
Open

fix(docs): correct default 'opts.triggers' modes in README trigger section #872

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,8 +317,8 @@ There's two ways that **which-key** can be triggered:

Both can be configured using `opts.triggers` and `opts.defer`.

By default `opts.triggers` includes `{ "<auto>", mode = "nixsotc" }`, which
will setup keymap triggers for every mode automatically and will trigger during
By default `opts.triggers` includes `{ "<auto>", mode = "nxso" }`, which
will setup keymap triggers for normal (`n`), visual (`x`), select (`s`), and operator-pending (`o`) modes automatically and will trigger during
`ModeChanged`.

> [!NOTE]
Expand All @@ -328,7 +328,7 @@ will setup keymap triggers for every mode automatically and will trigger during
>
> ```lua
> triggers = {
> { "<auto>", mode = "nixsotc" },
> { "<auto>", mode = "nxso" },
> { "a", mode = { "n", "v" } },
> }
> ```
Expand Down