aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/lua/vim')
-rw-r--r--runtime/lua/vim/_meta/vimfn.lua13
1 files changed, 13 insertions, 0 deletions
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index e00b2e6acd..f4daacfb7d 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -3599,6 +3599,19 @@ function vim.fn.getregion(pos1, pos2, opts) end
--- the offset of the character's first cell not included in the
--- selection, otherwise all its cells are included.
---
+--- Apart from the options supported by |getregion()|, {opts} also
+--- supports the following:
+---
+--- eol If |TRUE|, indicate positions beyond
+--- the end of a line with "col" values
+--- one more than the length of the line.
+--- If |FALSE|, positions are limited
+--- within their lines, and if a line is
+--- empty or the selection is entirely
+--- beyond the end of a line, a "col"
+--- value of 0 is used for both positions.
+--- (default: |FALSE|)
+---
--- @param pos1 table
--- @param pos2 table
--- @param opts? table