aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/api.txt
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2019-09-14 18:13:02 -0700
committerJustin M. Keyes <justinkz@gmail.com>2019-09-14 18:57:35 -0700
commitf2c75ef9b481e6c3b65f7b37a3c8e8afc5c73be3 (patch)
tree921c8355b1e089c989c83d19790bbcb68ea2cc08 /runtime/doc/api.txt
parent2e0e592ea29ea7d2da333824a93aa543a6f7f390 (diff)
downloadrneovim-f2c75ef9b481e6c3b65f7b37a3c8e8afc5c73be3.tar.gz
rneovim-f2c75ef9b481e6c3b65f7b37a3c8e8afc5c73be3.tar.bz2
rneovim-f2c75ef9b481e6c3b65f7b37a3c8e8afc5c73be3.zip
API: nvim_get_context: "opts" param
Since the parameter is already non-primitive, make it an `opts` map instead of just a list, in case we want to extend it later.
Diffstat (limited to 'runtime/doc/api.txt')
-rw-r--r--runtime/doc/api.txt9
1 files changed, 5 insertions, 4 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 18129e8c39..98dd330b48 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -1027,13 +1027,14 @@ nvim_get_color_map() *nvim_get_color_map()*
Return: ~
Map of color names and RGB values.
-nvim_get_context({types}) *nvim_get_context()*
+nvim_get_context({opts}) *nvim_get_context()*
Gets a map of the current editor state.
Parameters: ~
- {types} Context types ("regs", "jumps", "buflist",
- "gvars", ...) to gather, or NIL for all (see
- |context-types|).
+ {opts} Optional parameters.
+ • types: List of |context-types| ("regs", "jumps",
+ "bufs", "gvars", …) to gather, or empty for
+ "all".
Return: ~
map of global |context|.