aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/range.lua
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2026-05-30 07:35:05 -0400
committerGitHub <noreply@github.com>2026-05-30 07:35:05 -0400
commita9ef07681796f68324c59cd110f429247e142d1b (patch)
tree5ac952bcfef2f6d39cae1b2953ed8dc83164e04c /runtime/lua/vim/range.lua
parent6b799ee40a5729b6b2c7264b3987d1abf16839b6 (diff)
parentf5fae7aa5cf1e599b2bbc0ef0ae6deccc8c0b3d5 (diff)
downloadrneovim-a9ef07681796f68324c59cd110f429247e142d1b.tar.gz
rneovim-a9ef07681796f68324c59cd110f429247e142d1b.tar.bz2
rneovim-a9ef07681796f68324c59cd110f429247e142d1b.zip
Merge #39908 from justinmk/doc2
docs: misc
Diffstat (limited to 'runtime/lua/vim/range.lua')
-rw-r--r--runtime/lua/vim/range.lua9
1 files changed, 4 insertions, 5 deletions
diff --git a/runtime/lua/vim/range.lua b/runtime/lua/vim/range.lua
index 489b41e2b3..e8dd7d8bb9 100644
--- a/runtime/lua/vim/range.lua
+++ b/runtime/lua/vim/range.lua
@@ -10,12 +10,11 @@ local validate = vim.validate
local api = vim.api
local util = require('vim.pos._util')
---- Represents a range. Call `vim.range()` to create a new range.
+--- Represents a range based on [api-indexing] (0-indexed, end-exclusive). Call `vim.range()` to
+--- create a new range by passing start and end positions (|vim.Pos|).
---
---- A range contains a start and end position (see |vim.Pos|). The end position is exclusive.
---- Positions must have the same optional fields.
----
---- May include optional fields that enable additional capabilities, such as format conversions.
+--- Both positions must have the same optional fields, which may enable additional capabilities
+--- (such as format conversions).
---
--- Example:
--- ```lua