aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbfredl <bjorn.linse@gmail.com>2022-05-22 19:07:51 +0200
committerGitHub <noreply@github.com>2022-05-22 19:07:51 +0200
commit7f6d2984a86784c1a11a9f86ce827dbc7f648f28 (patch)
treea6193bf21372e7623cd2fa4290e9fdbe46dd7f60
parent3fe6bf3a1e50299dbdd6314afbb18e468eb7ce08 (diff)
parent86db222469d7f20acfca7c69fab129577deb9291 (diff)
downloadrneovim-7f6d2984a86784c1a11a9f86ce827dbc7f648f28.tar.gz
rneovim-7f6d2984a86784c1a11a9f86ce827dbc7f648f28.tar.bz2
rneovim-7f6d2984a86784c1a11a9f86ce827dbc7f648f28.zip
Merge pull request #18608 from ckipp01/extmarkDocs
docs(extmark): remove message about passing in id=0
-rw-r--r--runtime/doc/api.txt13
-rw-r--r--src/nvim/api/extmark.c11
2 files changed, 11 insertions, 13 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 7c669e3c9d..58ec9756a2 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -2656,13 +2656,12 @@ nvim_buf_get_extmarks({buffer}, {ns_id}, {start}, {end}, {opts})
nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {*opts})
Creates or updates an extmark.
- To create a new extmark, pass id=0. The extmark id will be
- returned. To move an existing mark, pass its id.
-
- It is also allowed to create a new mark by passing in a
- previously unused id, but the caller must then keep track of
- existing and unused ids itself. (Useful over RPC, to avoid
- waiting for the return value.)
+ By default a new extmark is created when no id is passed in,
+ but it is also possible to create a new mark by passing in a
+ previously unused id or move an existing mark by passing in
+ its id. The caller must then keep track of existing and unused
+ ids itself. (Useful over RPC, to avoid waiting for the return
+ value.)
Using the optional arguments, it is possible to use this to
highlight a range of text, and also to associate virtual text
diff --git a/src/nvim/api/extmark.c b/src/nvim/api/extmark.c
index d80bec2f70..94b2af9a6f 100644
--- a/src/nvim/api/extmark.c
+++ b/src/nvim/api/extmark.c
@@ -366,12 +366,11 @@ Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id, Object start, Object e
/// Creates or updates an extmark.
///
-/// To create a new extmark, pass id=0. The extmark id will be returned.
-/// To move an existing mark, pass its id.
-///
-/// It is also allowed to create a new mark by passing in a previously unused
-/// id, but the caller must then keep track of existing and unused ids itself.
-/// (Useful over RPC, to avoid waiting for the return value.)
+/// By default a new extmark is created when no id is passed in, but it is also
+/// possible to create a new mark by passing in a previously unused id or move
+/// an existing mark by passing in its id. The caller must then keep track of
+/// existing and unused ids itself. (Useful over RPC, to avoid waiting for the
+/// return value.)
///
/// Using the optional arguments, it is possible to use this to highlight
/// a range of text, and also to associate virtual text to the mark.