h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-05-02 02:41:15 -03:00
Code Issues Packages Projects Releases Wiki Activity

docs: omnibus cleanup

Browse Source 
Includes harmonizing the display of options and arguments, standardising
terminology, using the envvar directive more broadly, adding help options to all
commands that support them, simplifying some language, and tidying up multiple
formatting issues.

string documentation is not changed.
This commit is contained in:
David Adam
2022-03-12 00:18:41 +08:00
parent e23e52a8e9
commit 3a23fdf359
66 changed files with 278 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc_src/cmds/fish_opt.rst
View File

@@ -1,20 +1,20 @@
.. _cmd-fish_opt:
fish_opt - create an option spec for the argparse command
=========================================================
fish_opt - create an option specification for the argparse command
==================================================================
Synopsis
--------
.. synopsis::
fish_opt [--help]
fish_opt [(-slor | --multiple-vals=) OPTNAME]
fish_opt --help
Description
-----------
This command provides a way to produce option specifications suitable for use with the :ref:`argparse <cmd-argparse>` command. You can, of course, write the option specs by hand without using this command. But you might prefer to use this for the clarity it provides.
This command provides a way to produce option specifications suitable for use with the :ref:`argparse <cmd-argparse>` command. You can, of course, write the option specifications by hand without using this command. But you might prefer to use this for the clarity it provides.
The following ``argparse`` options are available:
@@ -42,7 +42,7 @@ The following ``argparse`` options are available:
Examples
--------
Define a single option spec for the boolean help flag:
Define a single option specification for the boolean help flag: