aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorbfredl <bjorn.linse@gmail.com>2022-05-05 17:31:02 +0200
committerGitHub <noreply@github.com>2022-05-05 17:31:02 +0200
commit1eecea8449557572295837d3213b2fdb42ce74ef (patch)
tree489d19c60d53cb3229a3d39dc00c57faeb293ac3 /runtime
parent82c7a82c3585100e73e154c49e3e002b7dc35437 (diff)
parent7aedcd8febaf74403851f8482529302e3ab30922 (diff)
downloadrneovim-1eecea8449557572295837d3213b2fdb42ce74ef.tar.gz
rneovim-1eecea8449557572295837d3213b2fdb42ce74ef.tar.bz2
rneovim-1eecea8449557572295837d3213b2fdb42ce74ef.zip
Merge pull request #18417 from famiu/feat/api/nvim_parse_cmd
refactor(api): make `range` in `nvim_parse_cmd` an array
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/api.txt15
1 files changed, 8 insertions, 7 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index d4477df803..bb7a238468 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -1775,14 +1775,15 @@ nvim_parse_cmd({str}, {opts}) *nvim_parse_cmd()*
Dictionary containing command information, with these
keys:
• cmd: (string) Command name.
- • range: (number) Number of items in the command
- |<range>|. Can be 0, 1 or 2.
- • line1: (number) Starting line of command |<range>|. -1
- if command cannot take a range. |<line1>|
- • line2: (number) Final line of command |<range>|. -1 if
- command cannot take a range. |<line2>|
+ • range: (array) Command <range>. Can have 0-2 elements
+ depending on how many items the range contains. Has no
+ elements if command doesn't accept a range or if no
+ range was specified, one element if only a single range
+ item was specified and two elements if both range items
+ were specified.
• count: (number) Any |<count>| that was supplied to the
- command. -1 if command cannot take a count.
+ command. -1 if command cannot take a count. Mutually
+ exclusive with "range".
• reg: (number) The optional command |<register>|, if
specified. Empty string if not specified or if command
cannot take a register.