aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/nvim/api/window.c7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/nvim/api/window.c b/src/nvim/api/window.c
index f10b4b900b..89fa2f86fb 100644
--- a/src/nvim/api/window.c
+++ b/src/nvim/api/window.c
@@ -492,7 +492,12 @@ Dictionary nvim_win_get_config(Window window, Error *err)
return rv;
}
-/// Hides the window (like |:hide| with a |window-ID|).
+/// Closes the window and hide the buffer it contains (like |:hide| with a
+/// |window-ID|).
+///
+/// Like |:hide| the buffer becomes hidden unless another window is editing it,
+/// or 'bufhidden' is `unload`, `delete` or `wipe` as opposed to |:close| or
+/// |nvim_win_close|, which will close the buffer.
///
/// @param window Window handle, or 0 for current window
/// @param[out] err Error details, if any