diff options
| author | bfredl <bjorn.linse@gmail.com> | 2022-09-30 09:59:45 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-30 09:59:45 +0200 |
| commit | b414e9fdbb87a0e868c863e6dad5791d156ab7bb (patch) | |
| tree | 7c62285b1c04c34e4c49fd2c1bb47bb15d6e9ae1 /runtime | |
| parent | df646572c53f55268a5dbb61628d7c3b302d5663 (diff) | |
| parent | cb62592bcb03d7934416cf46bede3b8296254c87 (diff) | |
| download | rneovim-b414e9fdbb87a0e868c863e6dad5791d156ab7bb.tar.gz rneovim-b414e9fdbb87a0e868c863e6dad5791d156ab7bb.tar.bz2 rneovim-b414e9fdbb87a0e868c863e6dad5791d156ab7bb.zip | |
Merge pull request #20364 from zeertzjq/parse-cmd-omit
fix(api)!: nvim_parse_cmd omit "count" "range" "reg" if not supported
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 2748d2b04c..d53ca01df0 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -1811,15 +1811,15 @@ nvim_parse_cmd({str}, {opts}) *nvim_parse_cmd()* Return: ~ Dictionary containing command information, with these keys: • cmd: (string) Command name. - • 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. - • reg: (string) The optional command |<register>|, if specified. Empty - string if not specified or if command cannot take a register. + • range: (array) (optional) Command range (|<line1>| |<line2>|). + Omitted if command doesn't accept a range. Otherwise, has no + elements if no range was specified, one element if only a single + range item was specified, or two elements if both range items were + specified. + • count: (number) (optional) Command |<count>|. Omitted if command + cannot take a count. + • reg: (string) (optional) Command |<register>|. Omitted if command + cannot take a register. • bang: (boolean) Whether command contains a |<bang>| (!) modifier. • args: (array) Command arguments. • addr: (string) Value of |:command-addr|. Uses short name. |