diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2024-04-20 23:21:08 +0200 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2024-05-12 23:41:00 +0200 |
| commit | 8f0a166da4cd919947ef1ed634d350ef602acc63 (patch) | |
| tree | 2a34c935653fee8505a96251b2ac0986aa543268 /runtime/doc/api.txt | |
| parent | d8b395b10fd033addef9765e30d9ab42e6cef264 (diff) | |
| download | rneovim-8f0a166da4cd919947ef1ed634d350ef602acc63.tar.gz rneovim-8f0a166da4cd919947ef1ed634d350ef602acc63.tar.bz2 rneovim-8f0a166da4cd919947ef1ed634d350ef602acc63.zip | |
refactor(api): rename nvim_win_remove_ns
Problem:
nvim_win_remove_ns does not follow `help dev-naming` API naming conventions.
Solution:
Rename it.
Diffstat (limited to 'runtime/doc/api.txt')
| -rw-r--r-- | runtime/doc/api.txt | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 86f4c3875c..f593f14929 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -2776,8 +2776,8 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {opts}) • url: A URL to associate with this extmark. In the TUI, the OSC 8 control sequence is used to generate a clickable hyperlink to this URL. - • scoped: boolean that indicates that the extmark should - only be displayed in the namespace scope. (experimental) + • scoped: boolean (EXPERIMENTAL) enables "scoping" for the + extmark. See |nvim_win_add_ns()| Return: ~ Id of the created/updated extmark @@ -2860,33 +2860,34 @@ nvim_set_decoration_provider({ns_id}, {opts}) < nvim_win_add_ns({window}, {ns_id}) *nvim_win_add_ns()* - Adds the namespace scope to the window. + Scopes a namespace to the a window, so extmarks in the namespace will be + active only in the given window. Parameters: ~ • {window} Window handle, or 0 for current window - • {ns_id} the namespace to add + • {ns_id} Namespace Return: ~ true if the namespace was added, else false -nvim_win_get_ns({window}) *nvim_win_get_ns()* - Gets all the namespaces scopes associated with a window. +nvim_win_del_ns({window}, {ns_id}) *nvim_win_del_ns()* + Unscopes a namespace (un-binds it from the given scope). Parameters: ~ • {window} Window handle, or 0 for current window + • {ns_id} the namespace to remove Return: ~ - a list of namespaces ids + true if the namespace was removed, else false -nvim_win_remove_ns({window}, {ns_id}) *nvim_win_remove_ns()* - Removes the namespace scope from the window. +nvim_win_get_ns({window}) *nvim_win_get_ns()* + Gets the namespace scopes for a given window. Parameters: ~ • {window} Window handle, or 0 for current window - • {ns_id} the namespace to remove Return: ~ - true if the namespace was removed, else false + a list of namespaces ids ============================================================================== |