diff options
| author | Javier Lopez <graulopezjavier@gmail.com> | 2021-11-01 08:46:26 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-01 07:46:26 -0600 |
| commit | 961cd83b3b39855b232841f37ded856c8621bd90 (patch) | |
| tree | f034a91a5f51a346fa4504a290265bb57bfe4b22 /runtime/doc/api.txt | |
| parent | fa97d34858fbb755e8bb6f161c49c18c7187eb4e (diff) | |
| download | rneovim-961cd83b3b39855b232841f37ded856c8621bd90.tar.gz rneovim-961cd83b3b39855b232841f37ded856c8621bd90.tar.bz2 rneovim-961cd83b3b39855b232841f37ded856c8621bd90.zip | |
refactor(api/marks)!: add opts param for feature extensibility (#16146)
In the future we might want to extend the concept of named marks and
adding opts reduces the need of changing the function signature in the
furute.
Diffstat (limited to 'runtime/doc/api.txt')
| -rw-r--r-- | runtime/doc/api.txt | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 1573bec7ac..bb8e83f84a 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -1078,7 +1078,7 @@ nvim_get_keymap({mode}) *nvim_get_keymap()* Array of maparg()-like dictionaries describing mappings. The "buffer" key is always zero. -nvim_get_mark({name}) *nvim_get_mark()* +nvim_get_mark({name}, {opts}) *nvim_get_mark()* Return a tuple (row, col, buffer, buffername) representing the position of the uppercase/file named mark. See |mark-motions|. @@ -1090,6 +1090,7 @@ nvim_get_mark({name}) *nvim_get_mark()* Parameters: ~ {name} Mark name + {opts} Optional parameters. Reserved for future use. Return: ~ 4-tuple (row, col, buffer, buffername), (0, 0, 0, '') if @@ -2420,7 +2421,7 @@ nvim_buf_set_lines({buffer}, {start}, {end}, {strict_indexing}, {replacement}) {replacement} Array of lines to use as replacement *nvim_buf_set_mark()* -nvim_buf_set_mark({buffer}, {name}, {line}, {col}) +nvim_buf_set_mark({buffer}, {name}, {line}, {col}, {opts}) Sets a named mark in the given buffer, all marks are allowed file/uppercase, visual, last change, etc. See |mark-motions|. @@ -2434,6 +2435,7 @@ nvim_buf_set_mark({buffer}, {name}, {line}, {col}) {name} Mark name {line} Line number {col} Column/row number + {opts} Optional parameters. Reserved for future use. Return: ~ true if the mark was set, else false. |