Skip to content

Commit 6229e38

Browse files
committed
docs(clue): improve example for <Leader> key submode
Related to #2185
1 parent 0697349 commit 6229e38

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

doc/mini-clue.txt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,8 @@ In this module submode can be implemented following these steps:
369369
this submode, pressing its prefix will be automatically emulated (leading
370370
back to being inside submode).
371371

372-
- Register submode prefix (or some of its starting part) as trigger.
372+
- Register submode prefix (or some of its starting part) as trigger. Do not
373+
register "overlapping" triggers, like `<Leader>` and `<Leader>m`.
373374

374375
## Submode examples ~
375376

@@ -395,10 +396,14 @@ In this module submode can be implemented following these steps:
395396

396397
require('mini.clue').setup({
397398
triggers = {
398-
{ mode = 'n', keys = '<Leader>m' },
399-
{ mode = 'x', keys = '<Leader>m' },
399+
-- This can also set up directly `<Leader>m` as a trigger, but make
400+
-- sure to not also use `<Leader>`, as they would "overlap"
401+
{ mode = 'n', keys = '<Leader>' },
402+
{ mode = 'x', keys = '<Leader>' },
400403
},
401404
clues = {
405+
{ mode = 'n', keys = '<Leader>m', desc = '+Move' },
406+
402407
{ mode = 'n', keys = '<Leader>mh', postkeys = '<Leader>m' },
403408
{ mode = 'n', keys = '<Leader>mj', postkeys = '<Leader>m' },
404409
{ mode = 'n', keys = '<Leader>mk', postkeys = '<Leader>m' },

lua/mini/clue.lua

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,8 @@
365365
--- this submode, pressing its prefix will be automatically emulated (leading
366366
--- back to being inside submode).
367367
---
368-
--- - Register submode prefix (or some of its starting part) as trigger.
368+
--- - Register submode prefix (or some of its starting part) as trigger. Do not
369+
--- register "overlapping" triggers, like `<Leader>` and `<Leader>m`.
369370
---
370371
--- ## Submode examples ~
371372
---
@@ -391,10 +392,14 @@
391392
---
392393
--- require('mini.clue').setup({
393394
--- triggers = {
394-
--- { mode = 'n', keys = '<Leader>m' },
395-
--- { mode = 'x', keys = '<Leader>m' },
395+
--- -- This can also set up directly `<Leader>m` as a trigger, but make
396+
--- -- sure to not also use `<Leader>`, as they would "overlap"
397+
--- { mode = 'n', keys = '<Leader>' },
398+
--- { mode = 'x', keys = '<Leader>' },
396399
--- },
397400
--- clues = {
401+
--- { mode = 'n', keys = '<Leader>m', desc = '+Move' },
402+
---
398403
--- { mode = 'n', keys = '<Leader>mh', postkeys = '<Leader>m' },
399404
--- { mode = 'n', keys = '<Leader>mj', postkeys = '<Leader>m' },
400405
--- { mode = 'n', keys = '<Leader>mk', postkeys = '<Leader>m' },

0 commit comments

Comments
 (0)