aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/api/vim.c
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2023-07-04 19:22:04 +0200
committerJustin M. Keyes <justinkz@gmail.com>2023-07-08 15:06:36 +0200
commit00d2f4b96eb9c8dcb6b9f67e256bb7faa19354db (patch)
treee3a07530c76cedf34435ce11df117a7e33a03a7d /src/nvim/api/vim.c
parent8c9e37cc09f5b79a981c574ab8bcfb0b9ed58ca8 (diff)
downloadrneovim-00d2f4b96eb9c8dcb6b9f67e256bb7faa19354db.tar.gz
rneovim-00d2f4b96eb9c8dcb6b9f67e256bb7faa19354db.tar.bz2
rneovim-00d2f4b96eb9c8dcb6b9f67e256bb7faa19354db.zip
docs: MAINTAIN.md, nvim_get_mark
Diffstat (limited to 'src/nvim/api/vim.c')
-rw-r--r--src/nvim/api/vim.c7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index 8c40e5ccd7..3ffaaab780 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -1980,12 +1980,13 @@ Boolean nvim_del_mark(String name, Error *err)
return res;
}
-/// Return a tuple (row, col, buffer, buffername) representing the position of
-/// the uppercase/file named mark. See |mark-motions|.
+/// Returns a `(row, col, buffer, buffername)` tuple representing the position
+/// of the uppercase/file named mark. "End of line" column position is returned
+/// as |v:maxcol| (big number). See |mark-motions|.
///
/// Marks are (1,0)-indexed. |api-indexing|
///
-/// @note fails with error if a lowercase or buffer local named mark is used.
+/// @note Lowercase name (or other buffer-local mark) is an error.
/// @param name Mark name
/// @param opts Optional parameters. Reserved for future use.
/// @return 4-tuple (row, col, buffer, buffername), (0, 0, 0, '') if the mark is