diff options
| author | Maxime Coste <mawww@kakoune.org> | 2019-04-15 17:42:58 +0200 |
|---|---|---|
| committer | Maxime Coste <mawww@kakoune.org> | 2019-04-17 08:38:52 +0200 |
| commit | 9118a18d5d72ac1814faf9dcba0635560800eb5f (patch) | |
| tree | 8311fdc5543da08f4d321f7f20025e3b95ddee54 /doc/interfacing.asciidoc | |
| parent | 02fc42a12a4025352b2da0f99728d5902a9c8448 (diff) | |
Change completions option docstring element to be an arbitrary command
We can have the previous behaviour by just passing the docstring to
`info -placement menu`.
Diffstat (limited to 'doc/interfacing.asciidoc')
| -rw-r--r-- | doc/interfacing.asciidoc | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/interfacing.asciidoc b/doc/interfacing.asciidoc index 5ab5f878..38fbe696 100644 --- a/doc/interfacing.asciidoc +++ b/doc/interfacing.asciidoc @@ -85,11 +85,15 @@ External completions are provided using an option to store completion, which have the following format. ---- -line.column[+len]@timestamp candidate1|desc1|menu1 candidate2|desc2|menu2 ... +line.column[+len]@timestamp candidate1|select1|menu1 candidate2|select2|menu2 ... ---- the first element of this string list specify where and when this completion -applies, the others are a triplet `<completion text>|<docstring>|<menu text>` +applies, the others are a triplet `<completion text>|<select cmd>|<menu text>` + +The select command is executed whenever this menu item gets selected, and +is usually used to display an item specific documentation with +`info -placement menu '<menu item description>'` The menu text is a markup string (see <<faces#markup-strings,`:doc faces markup-strings`>>), so it can contain `{face}` directives. |