Merge pull request #18608 from ckipp01/extmarkDocs

docs(extmark): remove message about passing in id=0
This commit is contained in:
bfredl 2022-05-22 19:07:51 +02:00 committed by GitHub
commit 7f6d2984a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 13 deletions

View File

@ -2656,13 +2656,12 @@ nvim_buf_get_extmarks({buffer}, {ns_id}, {start}, {end}, {opts})
nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {*opts}) nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {*opts})
Creates or updates an extmark. Creates or updates an extmark.
To create a new extmark, pass id=0. The extmark id will be By default a new extmark is created when no id is passed in,
returned. To move an existing mark, pass its id. 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
It is also allowed to create a new mark by passing in a its id. The caller must then keep track of existing and unused
previously unused id, but the caller must then keep track of ids itself. (Useful over RPC, to avoid waiting for the return
existing and unused ids itself. (Useful over RPC, to avoid value.)
waiting for the return value.)
Using the optional arguments, it is possible to use this to Using the optional arguments, it is possible to use this to
highlight a range of text, and also to associate virtual text highlight a range of text, and also to associate virtual text

View File

@ -366,12 +366,11 @@ Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id, Object start, Object e
/// Creates or updates an extmark. /// Creates or updates an extmark.
/// ///
/// To create a new extmark, pass id=0. The extmark id will be returned. /// By default a new extmark is created when no id is passed in, but it is also
/// To move an existing mark, pass its id. /// 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
/// It is also allowed to create a new mark by passing in a previously unused /// existing and unused ids itself. (Useful over RPC, to avoid waiting for the
/// id, but the caller must then keep track of existing and unused ids itself. /// return value.)
/// (Useful over RPC, to avoid waiting for the return value.)
/// ///
/// Using the optional arguments, it is possible to use this to highlight /// 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. /// a range of text, and also to associate virtual text to the mark.