Update completion documentation

This commit is contained in:
Martin Chaine 2016-08-17 18:11:07 +02:00
parent 8803bf7c46
commit b9144f151a

View File

@ -85,13 +85,13 @@ 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[|desc1[|menu1]]:candidate2[|desc2[|menu2]]:...
----
the first element of this string list specify where and when this completions
applies, the others are simply completion candidates, eventually containing
a descriptive text (after an `@` separator), and a separate menu text (after
the second `@` separator).
a descriptive text (after an `|` separator), and a separate menu text (after
the second `|` separator).
to effectively use that completion option, it should get added to the completers
option.