Skip to content

Commit 1f782e3

Browse files
committed
docs(clue): mention that desc field can be function
Related to #1526
1 parent 7a75a97 commit 1f782e3

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

doc/mini-clue.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -536,8 +536,8 @@ A clue table is a table with the following fields:
536536
- <keys> `(string)` - key combination for which clue will be shown.
537537
"Human-readable" key names as in |key-notation| (like "<Leader>", "<Space>",
538538
"<Tab>", etc.) are allowed.
539-
- <desc> `(string|nil)` - optional key combination description which will
540-
be shown in clue window.
539+
- <desc> `(string|function|nil)` - optional key combination description which is
540+
shown in clue window. If function, should return string description.
541541
- <postkeys> `(string|nil)` - optional postkeys which will be executed
542542
automatically after `keys`. Allows creation of submodes
543543
(see |MiniClue-examples-submodes|).

lua/mini/clue.lua

+2-2
Original file line numberDiff line numberDiff line change
@@ -532,8 +532,8 @@ end
532532
--- - <keys> `(string)` - key combination for which clue will be shown.
533533
--- "Human-readable" key names as in |key-notation| (like "<Leader>", "<Space>",
534534
--- "<Tab>", etc.) are allowed.
535-
--- - <desc> `(string|nil)` - optional key combination description which will
536-
--- be shown in clue window.
535+
--- - <desc> `(string|function|nil)` - optional key combination description which is
536+
--- shown in clue window. If function, should return string description.
537537
--- - <postkeys> `(string|nil)` - optional postkeys which will be executed
538538
--- automatically after `keys`. Allows creation of submodes
539539
--- (see |MiniClue-examples-submodes|).

0 commit comments

Comments
 (0)