diff options
| author | Corey Williamson <euclidianAce@protonmail.com> | 2021-03-10 13:29:01 -0600 |
|---|---|---|
| committer | Corey Williamson <euclidianAce@protonmail.com> | 2021-03-10 13:29:01 -0600 |
| commit | 3fbd9ed4ab1d7a90297488d778205e8dc270cbf4 (patch) | |
| tree | 3b6bd4032b3d72f22d541ca8456f502905e09b6a /src/nvim/api/window.c | |
| parent | 3a342f9cc9f0ca67620fe0886cdc7a5e03e6fece (diff) | |
| download | rneovim-3fbd9ed4ab1d7a90297488d778205e8dc270cbf4.tar.gz rneovim-3fbd9ed4ab1d7a90297488d778205e8dc270cbf4.tar.bz2 rneovim-3fbd9ed4ab1d7a90297488d778205e8dc270cbf4.zip | |
api: clarify difference between win_hide and win_close
Diffstat (limited to 'src/nvim/api/window.c')
| -rw-r--r-- | src/nvim/api/window.c | 7 |
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 |