diff options
author | Florian Bruhin <me@the-compiler.org> | 2018-11-30 12:45:01 +0100 |
---|---|---|
committer | Florian Bruhin <me@the-compiler.org> | 2018-11-30 12:45:01 +0100 |
commit | 569bb0fa0989ae3a87d7725d2a19c9d746bf42d8 (patch) | |
tree | f3461b05bc4e55db218ea9c3710907b17a51e5f3 /doc/contributing.asciidoc | |
parent | d549d4d5e2aff841150095b18681a75a10b36bbd (diff) | |
download | qutebrowser-569bb0fa0989ae3a87d7725d2a19c9d746bf42d8.tar.gz qutebrowser-569bb0fa0989ae3a87d7725d2a19c9d746bf42d8.zip |
Add cmdutils.Value instead of using count=True/win_id=True
Diffstat (limited to 'doc/contributing.asciidoc')
-rw-r--r-- | doc/contributing.asciidoc | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/contributing.asciidoc b/doc/contributing.asciidoc index 5f0e9bf9c..399633257 100644 --- a/doc/contributing.asciidoc +++ b/doc/contributing.asciidoc @@ -480,8 +480,9 @@ For `typing.Union` types, the given `choices` are only checked if other types The following arguments are supported for `@cmdutils.argument`: - `flag`: Customize the short flag (`-x`) the argument will get. -- `win_id=True`: Mark the argument as special window ID argument. -- `count=True`: Mark the argument as special count argument. +- `value`: Tell qutebrowser to fill the argument with special values: + - `value=cmdutils.Value.count`: The `count` given by the user to the command. + - `value=cmdutils.Value.win_id`: The window ID of the current window. - `completion`: A completion function (see `qutebrowser.completions.models.*`) to use when completing arguments for the given command. - `choices`: The allowed string choices for the argument. |