mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-12-04 21:52:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

vim-patch:87410ab3f556 (#27696)

Browse Source 
runtime(doc): some improvements to getregion() docs (vim/vim#14122)

- Mention the default selection behavior
- Remove useless sentence
- Correct description about space padding

87410ab3f5
This commit is contained in:
zeertzjq
2024-03-02 06:42:39 +08:00
committed by GitHub
parent b413f5d048
commit 1fe65b3457
3 changed files with 30 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
runtime/lua/vim/_meta/vimfn.lua generated
View File

@@ -3534,32 +3534,31 @@ function vim.fn.getreginfo(regname) end
--- The optional argument {opts} is a Dict and supports the
--- following items:
---
--- type Specify the selection type
--- type Specify the region's selection type
--- (default: "v"):
--- "v" for |charwise| mode
--- "V" for |linewise| mode
--- "<CTRL-V>" for |blockwise-visual| mode
---
--- exclusive If |TRUE|, use exclusive selection
--- for the end position 'selection'.
--- for the end position
--- (default: follow 'selection')
---
--- You can get the last selection type by |visualmode()|.
--- If Visual mode is active, use |mode()| to get the Visual mode
--- (e.g., in a |:vmap|).
--- This function uses the line and column number from the
--- specified position.
--- It is useful to get text starting and ending in different
--- columns, such as |charwise-visual| selection.
--- This function is useful to get text starting and ending in
--- different columns, such as a |charwise-visual| selection.
---
--- Note that:
--- - Order of {pos1} and {pos2} doesn't matter, it will always
--- return content from the upper left position to the lower
--- right position.
--- - If 'virtualedit' is enabled and selection is past the end of
--- line, resulting lines are filled with blanks.
--- - If the selection starts or ends in the middle of a multibyte
--- character, it is not included but its selected part is
--- substituted with spaces.
--- - If 'virtualedit' is enabled and the region is past the end
--- of the lines, resulting lines are padded with spaces.
--- - If the region is blockwise and it starts or ends in the
--- middle of a multi-cell character, it is not included but
--- its selected part is substituted with spaces.
--- - If {pos1} or {pos2} is not current in the buffer, an empty
--- list is returned.
---