aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/api
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2025-03-09 23:56:22 +0100
committerJustin M. Keyes <justinkz@gmail.com>2025-03-17 12:31:53 +0100
commitf96606371c13fd10280d737a4e3e2ae9149c2067 (patch)
treef508a3c9ae52ac10d682625201ec16e8d9fd7887 /src/nvim/api
parent041a939eeb21dd8a62c479f12cc9334d3d30a832 (diff)
downloadrneovim-f96606371c13fd10280d737a4e3e2ae9149c2067.tar.gz
rneovim-f96606371c13fd10280d737a4e3e2ae9149c2067.tar.bz2
rneovim-f96606371c13fd10280d737a4e3e2ae9149c2067.zip
docs: misc
Diffstat (limited to 'src/nvim/api')
-rw-r--r--src/nvim/api/buffer.c9
-rw-r--r--src/nvim/api/vim.c2
2 files changed, 5 insertions, 6 deletions
diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c
index 1cd9d2df76..f8ebf4b838 100644
--- a/src/nvim/api/buffer.c
+++ b/src/nvim/api/buffer.c
@@ -238,6 +238,8 @@ Boolean nvim_buf_detach(uint64_t channel_id, Buffer buffer, Error *err)
/// Out-of-bounds indices are clamped to the nearest valid value, unless
/// `strict_indexing` is set.
///
+/// @see |nvim_buf_get_text()|
+///
/// @param channel_id
/// @param buffer Buffer id, or 0 for current buffer
/// @param start First line index
@@ -294,7 +296,7 @@ ArrayOf(String) nvim_buf_get_lines(uint64_t channel_id,
///
/// Indexing is zero-based, end-exclusive. Negative indices are interpreted
/// as length+1+index: -1 refers to the index past the end. So to change
-/// or delete the last element use start=-2 and end=-1.
+/// or delete the last line use start=-2 and end=-1.
///
/// To insert lines at a given index, set `start` and `end` to the same index.
/// To delete a range of lines, set `replacement` to an empty array.
@@ -685,10 +687,7 @@ void nvim_buf_set_text(uint64_t channel_id, Buffer buffer, Integer start_row, In
});
}
-/// Gets a range from the buffer.
-///
-/// This differs from |nvim_buf_get_lines()| in that it allows retrieving only
-/// portions of a line.
+/// Gets a range from the buffer (may be partial lines, unlike |nvim_buf_get_lines()|).
///
/// Indexing is zero-based. Row indices are end-inclusive, and column indices
/// are end-exclusive.
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index 96cc8b68ae..70f5ebacb7 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -872,7 +872,7 @@ Window nvim_get_current_win(void)
return curwin->handle;
}
-/// Sets the current window. Also changes tabpage, if necessary.
+/// Sets the current window (and tabpage, implicitly).
///
/// @param window |window-ID| to focus
/// @param[out] err Error details, if any