pep/poezio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix wording in command_args_parser.quoted docstring

Browse source 
Signed-off-by: Maxime “pep” Buquet <pep@bouah.net>
This commit is contained in:
Maxime “pep” Buquet 2019-02-05 00:45:17 +00:00
parent ebc886d670
commit e5bc466b27
Signed by: pep
GPG key ID: DEDA74AEECA9D0F2
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
poezio/decorators.py
View file

@ -91,18 +91,18 @@ class CommandArgParser:
the numbers `mandatory` and `optional`. the numbers `mandatory` and `optional`.
If the string doesn’t contain at least `mandatory` arguments, we return If the string doesn’t contain at least `mandatory` arguments, we return
None because the given arguments are invalid. None because the given arguments are invalid.
If there are any remaining arguments after `mandatory` and `optional` If there are any remaining arguments after `mandatory` and `optional`
arguments have been found (and “ignore_trailing_arguments" is not True), arguments have been found (and “ignore_trailing_arguments" is not True),
we happen them to the last argument of the list. we append them to the last argument of the list.
An argument is a string (with or without whitespaces) between to quotes An argument is a string (with or without whitespaces) between two quotes
("), or a whitespace separated word (if not inside quotes). ("), or a whitespace separated word (if not inside quotes).
The argument `defaults` is a list of strings that are used when an The argument `defaults` is a list of strings that are used when an
optional argument is missing. For example if we accept one optional optional argument is missing. For example if we accept one optional
argument, zero is available but we have one value in the `defaults` argument and none is provided, but we have one value in the `defaults`
list, we use that string inplace. The `defaults` list can only list, we use that string inplace. The `defaults` list can only
replace missing optional arguments, not mandatory ones. And it replace missing optional arguments, not mandatory ones. And it
should not contain more than `mandatory` values. Also you cannot should not contain more than `mandatory` values. Also you cannot