diff options
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/api.txt | 14 | ||||
| -rw-r--r-- | runtime/doc/news.txt | 2 |
2 files changed, 11 insertions, 5 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index f593f14929..13884e865d 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -2777,7 +2777,7 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {opts}) OSC 8 control sequence is used to generate a clickable hyperlink to this URL. • scoped: boolean (EXPERIMENTAL) enables "scoping" for the - extmark. See |nvim_win_add_ns()| + extmark. See |nvim__win_add_ns()| Return: ~ Id of the created/updated extmark @@ -2859,7 +2859,9 @@ nvim_set_decoration_provider({ns_id}, {opts}) ["end", tick] < -nvim_win_add_ns({window}, {ns_id}) *nvim_win_add_ns()* +nvim__win_add_ns({window}, {ns_id}) *nvim__win_add_ns()* + EXPERIMENTAL: this API will change in the future. + Scopes a namespace to the a window, so extmarks in the namespace will be active only in the given window. @@ -2870,7 +2872,9 @@ nvim_win_add_ns({window}, {ns_id}) *nvim_win_add_ns()* Return: ~ true if the namespace was added, else false -nvim_win_del_ns({window}, {ns_id}) *nvim_win_del_ns()* +nvim__win_del_ns({window}, {ns_id}) *nvim__win_del_ns()* + EXPERIMENTAL: this API will change in the future. + Unscopes a namespace (un-binds it from the given scope). Parameters: ~ @@ -2880,7 +2884,9 @@ nvim_win_del_ns({window}, {ns_id}) *nvim_win_del_ns()* Return: ~ true if the namespace was removed, else false -nvim_win_get_ns({window}) *nvim_win_get_ns()* +nvim__win_get_ns({window}) *nvim__win_get_ns()* + EXPERIMENTAL: this API will change in the future. + Gets the namespace scopes for a given window. Parameters: ~ diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index b6add63595..42b6f4b14c 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -216,7 +216,7 @@ The following new APIs and features were added. |nvim_win_set_config()|. • |nvim_input_mouse()| supports mouse buttons "x1" and "x2". • Added |nvim_tabpage_set_win()| to set the current window of a tabpage. - • |nvim_win_add_ns()| can bind a |namespace| to a window-local scope(s). + • |nvim__win_add_ns()| can bind a |namespace| to a window-local scope(s). • Extmarks opt-in to this scoping via the `scoped` flag of |nvim_buf_set_extmark()|. • 'foldtext' now supports virtual text format. |fold-foldtext| |