github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-27 03:13:37 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Slight reword of argparse's optional argument section

Browse Source 
[ci skip]
This commit is contained in:
Fabian Homborg 2020-06-16 21:38:02 +02:00
parent bc68ada893
commit 547f649797
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc_src/cmds/argparse.rst
View File

@ -108,13 +108,13 @@ Note: Optional arguments
An option defined with ``=?`` can take optional arguments. Optional arguments have to be *directly attached* to the option they belong to.
That means you can only call::
That means the argument will only be used for the option if you use it like::
cmd --flag=value
# or
cmd -fvalue
but not::
but not if used like::
cmd --flag value
# "value" here will be used as a positional argument and "--flag" won't have an argument.
@ -124,9 +124,9 @@ If this weren't the case, using an option without an optional argument would be
For example::
grep --color auto
# Here "auto" will be used as the search string, "color" will not have an argument and will fall back to the default
# Here "auto" will be used as the search string, "color" will not have an argument and will fall back to the default, which also *happens to be* auto.
This isn't specific to argparse but common to all things using ``getopt(3)`` (if they have optional arguments at all).
This isn't specific to argparse but common to all things using ``getopt(3)`` (if they have optional arguments at all). That ``grep`` example is how GNU grep actually behaves.
Flag Value Validation
---------------------