mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-13 14:58:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: fix invalid help tags #12745

Browse Source
This commit is contained in:
Georgy Komarov
2020-09-06 08:10:56 +03:00
committed by GitHub
parent bedab7e87b
commit e57ea5f2a9
2 changed files with 24 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
runtime/doc/api.txt
View File

@@ -336,7 +336,7 @@ callbacks. These callbacks are called frequently in various contexts;
|textlock| prevents changing buffer contents and window layout (use |textlock| prevents changing buffer contents and window layout (use
|vim.schedule| to defer such operations to the main loop instead). |vim.schedule| to defer such operations to the main loop instead).
|nvim_buf_attach| will take keyword args for the callbacks. "on_lines" will |nvim_buf_attach()| will take keyword args for the callbacks. "on_lines" will
receive parameters ("lines", {buf}, {changedtick}, {firstline}, {lastline}, receive parameters ("lines", {buf}, {changedtick}, {firstline}, {lastline},
{new_lastline}, {old_byte_size}[, {old_utf32_size}, {old_utf16_size}]). {new_lastline}, {old_byte_size}[, {old_utf32_size}, {old_utf16_size}]).
Unlike remote channel events the text contents are not passed. The new text can Unlike remote channel events the text contents are not passed. The new text can
@@ -355,7 +355,7 @@ was changed. The parameters recieved are ("changedtick", {buf}, {changedtick}).
*api-lua-detach* *api-lua-detach*
In-process Lua callbacks can detach by returning `true`. This will detach all In-process Lua callbacks can detach by returning `true`. This will detach all
callbacks attached with the same |nvim_buf_attach| call. callbacks attached with the same |nvim_buf_attach()| call.
============================================================================== ==============================================================================
@@ -1603,19 +1603,20 @@ nvim_buf_add_highlight({buffer}, {src_id}, {hl_group}, {line},
marks do. marks do.
Namespaces are used for batch deletion/updating of a set of Namespaces are used for batch deletion/updating of a set of
highlights. To create a namespace, use |nvim_create_namespace| highlights. To create a namespace, use
which returns a namespace id. Pass it in to this function as |nvim_create_namespace()| which returns a namespace id. Pass
`ns_id` to add highlights to the namespace. All highlights in it in to this function as `ns_id` to add highlights to the
the same namespace can then be cleared with single call to namespace. All highlights in the same namespace can then be
|nvim_buf_clear_namespace|. If the highlight never will be cleared with single call to |nvim_buf_clear_namespace()|. If
deleted by an API call, pass `ns_id = -1` . the highlight never will be deleted by an API call, pass
`ns_id = -1` .
As a shorthand, `ns_id = 0` can be used to create a new As a shorthand, `ns_id = 0` can be used to create a new
namespace for the highlight, the allocated id is then namespace for the highlight, the allocated id is then
returned. If `hl_group` is the empty string no highlight is returned. If `hl_group` is the empty string no highlight is
added, but a new `ns_id` is still returned. This is supported added, but a new `ns_id` is still returned. This is supported
for backwards compatibility, new code should use for backwards compatibility, new code should use
|nvim_create_namespace| to create a new empty namespace. |nvim_create_namespace()| to create a new empty namespace.
Parameters: ~ Parameters: ~
{buffer} Buffer handle, or 0 for current buffer {buffer} Buffer handle, or 0 for current buffer
@@ -2066,12 +2067,12 @@ nvim_buf_set_virtual_text({buffer}, {src_id}, {line}, {chunks},
Namespaces are used to support batch deletion/updating of Namespaces are used to support batch deletion/updating of
virtual text. To create a namespace, use virtual text. To create a namespace, use
|nvim_create_namespace|. Virtual text is cleared using |nvim_create_namespace()|. Virtual text is cleared using
|nvim_buf_clear_namespace|. The same `ns_id` can be used for |nvim_buf_clear_namespace()|. The same `ns_id` can be used for
both virtual text and highlights added by both virtual text and highlights added by
|nvim_buf_add_highlight|, both can then be cleared with a |nvim_buf_add_highlight()|, both can then be cleared with a
single call to |nvim_buf_clear_namespace|. If the virtual text single call to |nvim_buf_clear_namespace()|. If the virtual
never will be cleared by an API call, pass `ns_id = -1` . text never will be cleared by an API call, pass `ns_id = -1` .
As a shorthand, `ns_id = 0` can be used to create a new As a shorthand, `ns_id = 0` can be used to create a new
namespace for the virtual text, the allocated id is then namespace for the virtual text, the allocated id is then

18
src/nvim/api/buffer.c
View File

@@ -1535,17 +1535,17 @@ Boolean nvim_buf_del_extmark(Buffer buffer,
/// like signs and marks do. /// like signs and marks do.
/// ///
/// Namespaces are used for batch deletion/updating of a set of highlights. To /// Namespaces are used for batch deletion/updating of a set of highlights. To
/// create a namespace, use |nvim_create_namespace| which returns a namespace /// create a namespace, use |nvim_create_namespace()| which returns a namespace
/// id. Pass it in to this function as `ns_id` to add highlights to the /// id. Pass it in to this function as `ns_id` to add highlights to the
/// namespace. All highlights in the same namespace can then be cleared with /// namespace. All highlights in the same namespace can then be cleared with
/// single call to |nvim_buf_clear_namespace|. If the highlight never will be /// single call to |nvim_buf_clear_namespace()|. If the highlight never will be
/// deleted by an API call, pass `ns_id = -1`. /// deleted by an API call, pass `ns_id = -1`.
/// ///
/// As a shorthand, `ns_id = 0` can be used to create a new namespace for the /// As a shorthand, `ns_id = 0` can be used to create a new namespace for the
/// highlight, the allocated id is then returned. If `hl_group` is the empty /// highlight, the allocated id is then returned. If `hl_group` is the empty
/// string no highlight is added, but a new `ns_id` is still returned. This is /// string no highlight is added, but a new `ns_id` is still returned. This is
/// supported for backwards compatibility, new code should use /// supported for backwards compatibility, new code should use
/// |nvim_create_namespace| to create a new empty namespace. /// |nvim_create_namespace()| to create a new empty namespace.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer handle, or 0 for current buffer
/// @param ns_id namespace to use or -1 for ungrouped highlight /// @param ns_id namespace to use or -1 for ungrouped highlight
@@ -1647,7 +1647,7 @@ void nvim_buf_clear_namespace(Buffer buffer,
/// Clears highlights and virtual text from namespace and range of lines /// Clears highlights and virtual text from namespace and range of lines
/// ///
/// @deprecated use |nvim_buf_clear_namespace|. /// @deprecated use |nvim_buf_clear_namespace()|.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer handle, or 0 for current buffer
/// @param ns_id Namespace to clear, or -1 to clear all. /// @param ns_id Namespace to clear, or -1 to clear all.
@@ -1711,11 +1711,11 @@ free_exit:
/// begin one cell (|lcs-eol| or space) after the ordinary text. /// begin one cell (|lcs-eol| or space) after the ordinary text.
/// ///
/// Namespaces are used to support batch deletion/updating of virtual text. /// Namespaces are used to support batch deletion/updating of virtual text.
/// To create a namespace, use |nvim_create_namespace|. Virtual text is /// To create a namespace, use |nvim_create_namespace()|. Virtual text is
/// cleared using |nvim_buf_clear_namespace|. The same `ns_id` can be used for /// cleared using |nvim_buf_clear_namespace()|. The same `ns_id` can be used for
/// both virtual text and highlights added by |nvim_buf_add_highlight|, both /// both virtual text and highlights added by |nvim_buf_add_highlight()|, both
/// can then be cleared with a single call to |nvim_buf_clear_namespace|. If the /// can then be cleared with a single call to |nvim_buf_clear_namespace()|. If
/// virtual text never will be cleared by an API call, pass `ns_id = -1`. /// the virtual text never will be cleared by an API call, pass `ns_id = -1`.
/// ///
/// As a shorthand, `ns_id = 0` can be used to create a new namespace for the /// As a shorthand, `ns_id = 0` can be used to create a new namespace for the
/// virtual text, the allocated id is then returned. /// virtual text, the allocated id is then returned.