diff options
Diffstat (limited to 'src/nvim/eval.lua')
| -rw-r--r-- | src/nvim/eval.lua | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua index 9f662c6457..6b4c88f071 100644 --- a/src/nvim/eval.lua +++ b/src/nvim/eval.lua @@ -13185,16 +13185,14 @@ M.funcs = { args = 1, base = 1, desc = [=[ - The result is a Number, which is the height of window {nr}. - {nr} can be the window number or the |window-ID|. - When {nr} is zero, the height of the current window is - returned. When window {nr} doesn't exist, -1 is returned. - An existing window always has a height of zero or more. - This excludes any window toolbar line. + Gets the height of |window-ID| {nr} (zero for "current + window"), excluding any 'winbar' and 'statusline'. Returns -1 + if window {nr} doesn't exist. An existing window always has + a height of zero or more. + Examples: >vim - echo "The current window has " .. winheight(0) .. " lines." + echo "Current window has " .. winheight(0) .. " lines." < - ]=], name = 'winheight', params = { { 'nr', 'integer' } }, @@ -13377,19 +13375,21 @@ M.funcs = { args = 1, base = 1, desc = [=[ - The result is a Number, which is the width of window {nr}. - {nr} can be the window number or the |window-ID|. - When {nr} is zero, the width of the current window is - returned. When window {nr} doesn't exist, -1 is returned. - An existing window always has a width of zero or more. - Examples: >vim - echo "The current window has " .. winwidth(0) .. " columns." + Gets the width of |window-ID| {nr} (zero for "current + window"), including columns (|sign-column|, 'statuscolumn', + etc.). Returns -1 if window {nr} doesn't exist. An existing + window always has a width of zero or more. + + Example: >vim + echo "Current window has " .. winwidth(0) .. " columns." if winwidth(0) <= 50 50 wincmd | endif - <For getting the terminal or screen size, see the 'columns' - option. - + < + To get the buffer "viewport", use |getwininfo()|: >vim + :echo getwininfo(win_getid())[0].width - getwininfo(win_getid())[0].textoff + < + To get the Nvim screen size, see the 'columns' option. ]=], name = 'winwidth', params = { { 'nr', 'integer' } }, |