diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2024-05-12 23:12:25 +0200 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2024-05-12 23:53:24 +0200 |
| commit | 97c7646501d5cd6f57c57ce30acca89c5b8573ff (patch) | |
| tree | a2e0e786f5f6b829ebb39b58e0e536ffd87c546c /runtime/doc/api.txt | |
| parent | 8f0a166da4cd919947ef1ed634d350ef602acc63 (diff) | |
| download | rneovim-97c7646501d5cd6f57c57ce30acca89c5b8573ff.tar.gz rneovim-97c7646501d5cd6f57c57ce30acca89c5b8573ff.tar.bz2 rneovim-97c7646501d5cd6f57c57ce30acca89c5b8573ff.zip | |
refactor(api): nvim_win_xx_ns are EXPERIMENTAL
Problem:
The nvim_win_xx_ns function family introduced in ba0370b1d718d473d0ef51c35d88b98ba220082b
needs more bake-time. Currently it's narrowly defined for windows, but
other scopes ("buffer") and features are likely in the future.
Solution:
- Rename the API with double-underscore to mark it as EXPERIMENTAL.
TODO/FUTURE:
- Rename and change the signature to support more than just "window"
scope, and for other flexibility.
- Open question: we could choose either:
- "store scopes on namespaces", or
- "store namespaces on scopes (w:/b:/…)"
Diffstat (limited to 'runtime/doc/api.txt')
| -rw-r--r-- | runtime/doc/api.txt | 14 |
1 files changed, 10 insertions, 4 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: ~ |