aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/api.txt
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc/api.txt')
-rw-r--r--runtime/doc/api.txt12
1 files changed, 6 insertions, 6 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index fb4818bc2f..7c87ca7887 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -46,7 +46,7 @@ version.api_prerelease Declares the API as unstable/unreleased >
(version.api_prerelease && fn.since == version.api_level)
functions API function signatures
ui_events UI event signatures |ui|
-ui_options Supported |ui-options|
+ui_options Supported |ui-option|s
{fn}.since API level where function {fn} was introduced
{fn}.deprecated_since API level where function {fn} was deprecated
types Custom handle types defined by Nvim
@@ -766,7 +766,7 @@ nvim_get_color_by_name({name}) *nvim_get_color_by_name()*
Returns the 24-bit RGB value of a |nvim_get_color_map()| color
name or "#rrggbb" hexadecimal string.
- Examples: >
+ Example: >
:echo nvim_get_color_by_name("Pink")
:echo nvim_get_color_by_name("#cbcbcb")
<
@@ -1104,11 +1104,11 @@ nvim_list_uis() *nvim_list_uis()*
Return: ~
Array of UI dictionaries, each with these keys:
- - "height" requested height of the UI
- - "width" requested width of the UI
+ - "height" Requested height of the UI
+ - "width" Requested width of the UI
- "rgb" true if the UI uses RGB colors (false implies
|cterm-colors|)
- - "ext_..." Requested UI extensions, see |ui-options|
+ - "ext_..." Requested UI extensions, see |ui-option|
- "chan" Channel id of remote UI (not present for TUI)
nvim_get_proc_children({pid}) *nvim_get_proc_children()*
@@ -1765,7 +1765,7 @@ nvim_ui_attach({width}, {height}, {options}) *nvim_ui_attach()*
Parameters: ~
{width} Requested screen columns
{height} Requested screen rows
- {options} |ui-options| map
+ {options} |ui-option| map
nvim_ui_detach() *nvim_ui_detach()*
Deactivates UI events on the channel.