docs(clue): mention that desc field can be function

Related to #1526
echasnovski · Jan 27, 2025 · 1f782e3 · 1f782e3
1 parent 7a75a97
commit 1f782e3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/doc/mini-clue.txt b/doc/mini-clue.txt
@@ -536,8 +536,8 @@ A clue table is a table with the following fields:
 - <keys> `(string)` - key combination for which clue will be shown.
   "Human-readable" key names as in |key-notation| (like "<Leader>", "<Space>",
   "<Tab>", etc.) are allowed.
-- <desc> `(string|nil)` - optional key combination description which will
-  be shown in clue window.
+- <desc> `(string|function|nil)` - optional key combination description which is
+  shown in clue window. If function, should return string description.
 - <postkeys> `(string|nil)` - optional postkeys which will be executed
   automatically after `keys`. Allows creation of submodes
   (see |MiniClue-examples-submodes|).

diff --git a/lua/mini/clue.lua b/lua/mini/clue.lua
@@ -532,8 +532,8 @@ end
 --- - <keys> `(string)` - key combination for which clue will be shown.
 ---   "Human-readable" key names as in |key-notation| (like "<Leader>", "<Space>",
 ---   "<Tab>", etc.) are allowed.
---- - <desc> `(string|nil)` - optional key combination description which will
----   be shown in clue window.
+--- - <desc> `(string|function|nil)` - optional key combination description which is
+---   shown in clue window. If function, should return string description.
 --- - <postkeys> `(string|nil)` - optional postkeys which will be executed
 ---   automatically after `keys`. Allows creation of submodes
 ---   (see |MiniClue-examples-submodes|).