api: clarify difference between win_hide and win_close

This commit is contained in:
Corey Williamson
2021-03-10 13:29:01 -06:00
parent 3a342f9cc9
commit 3fbd9ed4ab

View File

@@ -492,7 +492,12 @@ Dictionary nvim_win_get_config(Window window, Error *err)
return rv; 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 window Window handle, or 0 for current window
/// @param[out] err Error details, if any /// @param[out] err Error details, if any