From e5bc466b2751b2a2b3dfe5a3ef34e34cf0e79392 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maxime=20=E2=80=9Cpep=E2=80=9D=20Buquet?= Date: Tue, 5 Feb 2019 00:45:17 +0000 Subject: [PATCH] Fix wording in command_args_parser.quoted docstring MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Maxime “pep” Buquet --- poezio/decorators.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/poezio/decorators.py b/poezio/decorators.py index bf1c2ebe..4b5d0320 100644 --- a/poezio/decorators.py +++ b/poezio/decorators.py @@ -91,18 +91,18 @@ class CommandArgParser: the numbers `mandatory` and `optional`. 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` 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). The argument `defaults` is a list of strings that are used when an 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 replace missing optional arguments, not mandatory ones. And it should not contain more than `mandatory` values. Also you cannot