Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-09-20 06:22:12 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs/argparse: Explain dashes in flag names

Browse source
This commit is contained in:
Fabian Boehm 2024-09-15 09:35:18 +02:00
parent 1e2368f609
commit f9635b1a04
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc_src/cmds/argparse.rst
View file

@ -78,6 +78,8 @@ To use the flags argparse has extracted::
set -ql _flag_name[1]
and set myname $_flag_name[-1] # here we use the *last* --name=
Any characters in the flag name that are not valid in a variable name (like ``-`` dashes) will be replaced with underscores.
The ``--`` argument is required. You do not have to include any option specifications or arguments after the ``--`` but you must include the ``--``. For example, this is acceptable::
set -l argv foo
@ -248,6 +250,13 @@ After this it figures out which variable it should operate on according to the `
set -q _flag_path
and set var PATH
# ...
# Check for --dry-run.
# The "-" has been replaced with a "_" because
# it is not valid in a variable name
not set -ql _flag_dry_run
and set $var $result
Limitations