xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix documentation of completions and range-faces options

Browse Source 
Fixes #771
This commit is contained in:
Maxime Coste 2016-08-27 11:05:22 +01:00
parent 85f54a77ac
commit 0c444c3f4b
2 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.asciidoc
View File

@ -820,9 +820,14 @@ Options are typed, their type can be
* `{int,str}-list`: a list, elements are separated by a colon (:) * `{int,str}-list`: a list, elements are separated by a colon (:)
if an element needs to contain a colon, it can be escaped with a if an element needs to contain a colon, it can be escaped with a
backslash. backslash.
* `range-faces`: a list, elements are separated by a colon (:), of * `range-faces`: a `:` separated list of a pairs of a buffer range
a buffer range (<begin line>.<begin column>,<end line>.<end column>) (`<begin line>.<begin column>,<end line>.<end column>`) and a face
and a face (separated by `|`) (separated by `|`), except for the first element which is just the
timestamp of the buffer.
* `completions`: a `:` separated list of `<text>|<docstring>|<menu text>`
candidates, except for the first element which follows the
`<line>.<column>[+<length>]@<timestamp>` format to define where the
completion apply in the buffer.
* `enum(value1|value2|...)`: an enum, taking on of the given values * `enum(value1|value2|...)`: an enum, taking on of the given values
* `flags(value1|value2|...)`: a set of flags, taking a combination * `flags(value1|value2|...)`: a set of flags, taking a combination
of the given values joined by `|`. of the given values joined by `|`.
@ -893,10 +898,7 @@ Some options are built in Kakoune, and can be used to control it's behaviour:
(`word=all`) or only the current one (`word=buffer`) (`word=all`) or only the current one (`word=buffer`)
- `filename` which tries to detect when a filename is being entered and - `filename` which tries to detect when a filename is being entered and
provides completion based on local filesystem. provides completion based on local filesystem.
- `option=<opt-name>` where <opt-name> is a _completions_ option, which is a `:` - `option=<opt-name>` where <opt-name> is a _completions_ option.
separated list of _<text>|<docstring>|<menu text>_ candidates, except for the first
element which follows the _<line>.<column>[+<length>]@<timestamp>_ format to define
where the completion apply in the buffer.
* `static_words` _str-list_: list of words that are always added to completion * `static_words` _str-list_: list of words that are always added to completion
candidates when completing words in insert mode. candidates when completing words in insert mode.
* `completions_extra_word_chars` _str_: a string containing all additional character * `completions_extra_word_chars` _str_: a string containing all additional character

20
doc/manpages/options.asciidoc
View File

@ -23,9 +23,15 @@ Types
to contain a colon, it can be escaped to contain a colon, it can be escaped
with a backslash with a backslash
*range-faces*:: *range-faces*::
a list, elements are separated by a colon (:), of pairs of buffer a `:` separated list of a pairs of a buffer range
range (`<begin line>.<begin column>,<end line>.<end column>`) and (`<begin line>.<begin column>,<end line>.<end column>`) and a face
face (separated by `|`) (separated by `|`), except for the first element which is just the
timestamp of the buffer.
*completions*::
a `:` separated list of `<text>|<docstring>|<menu text>`
candidates, except for the first element which follows the
`<line>.<column>[+<length>]@<timestamp>` format to define where the
completion apply in the buffer.
*enum(value1|value2|...)*:: *enum(value1|value2|...)*::
an enum, taking one of the given values an enum, taking one of the given values
*flags(value1|value2|...)*:: *flags(value1|value2|...)*::
@ -116,13 +122,7 @@ Builtin options
provides completion based on local filesystem provides completion based on local filesystem
*option=<opt-name>*::: *option=<opt-name>*:::
where *opt-name* is a 'str-list' option. The first element where *opt-name* is a 'completions' option.
of the list should follow the format:
<line>.<column>[+<length>]@<timestamp>
to define where the completion apply in the buffer, and the
other strings are the candidates
*static_words* 'str-list':: *static_words* 'str-list'::
list of words that are always added to completion candidates list of words that are always added to completion candidates