diff options
| author | Famiu Haque <famiuhaque@protonmail.com> | 2022-05-05 01:49:29 +0600 |
|---|---|---|
| committer | Famiu Haque <famiuhaque@protonmail.com> | 2022-05-05 20:35:14 +0600 |
| commit | 7aedcd8febaf74403851f8482529302e3ab30922 (patch) | |
| tree | 68754c8f27c0a26919d2a56412dea60732551b57 /runtime | |
| parent | e6c71574a07662c44b83c6cb07bf9b61bc06e136 (diff) | |
| download | rneovim-7aedcd8febaf74403851f8482529302e3ab30922.tar.gz rneovim-7aedcd8febaf74403851f8482529302e3ab30922.tar.bz2 rneovim-7aedcd8febaf74403851f8482529302e3ab30922.zip | |
refactor(api): make `range` in `nvim_parse_cmd` an array
Changes the `range` value in `nvim_parse_cmd` into an array to describe
range information more concisely. Also makes `range` and `count` be
mutually exclusive by making count `-1` when command takes a range
instead of a count. Additionally corrects the behavior of `count` for
built-in commands by making the default count `0`.
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 15 |
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. |