diff options
author | Justin M. Keyes <justinkz@gmail.com> | 2018-12-30 21:17:18 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-12-30 21:17:18 +0100 |
commit | 1e8d2bdc487cdebf152eb228ed936720cfed3a76 (patch) | |
tree | f4933a9250ac93d6dd6998b9bafb87bb1beae8ab /runtime/doc/api.txt | |
parent | fa5182489a660e672bac6ea78ba4eefcbba9d6eb (diff) | |
parent | a10fdc70aa1e7e48421a473a2fab49b79089426c (diff) | |
download | rneovim-1e8d2bdc487cdebf152eb228ed936720cfed3a76.tar.gz rneovim-1e8d2bdc487cdebf152eb228ed936720cfed3a76.tar.bz2 rneovim-1e8d2bdc487cdebf152eb228ed936720cfed3a76.zip |
Merge #9335 from justinmk/doc
Diffstat (limited to 'runtime/doc/api.txt')
-rw-r--r-- | runtime/doc/api.txt | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 7dab69df22..2520a15890 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -546,25 +546,24 @@ nvim_set_current_tabpage({tabpage}) *nvim_set_current_tabpage()* {tabpage} Tabpage handle nvim_create_namespace({name}) *nvim_create_namespace()* - create a new namespace, or get one with an exisiting name + Creates a new namespace, or gets an existing one - Namespaces are currently used for buffer highlighting and - virtual text, see |nvim_buf_add_highlight| and - |nvim_buf_set_virtual_text|. + Namespaces are used for buffer highlights and virtual text, + see |nvim_buf_add_highlight()| and + |nvim_buf_set_virtual_text()|. - Namespaces can have a name of be anonymous. If `name` is a - non-empty string, and a namespace already exists with that - name,the existing namespace id is returned. If an empty string - is used, a new anonymous namespace is returned. + Namespaces can be named or anonymous. If `name` matches an + existing namespace, the associated id is returned. If `name` + is an empty string a new, anonymous namespace is created. Parameters: ~ - {name} Name of the namespace or empty string + {name} Namespace name or empty string Return: ~ - the namespace id + Namespace id nvim_get_namespaces() *nvim_get_namespaces()* - Get existing named namespaces + Gets existing, non-anonymous namespaces Return: ~ dict that maps from names to namespace ids. |