github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2025-02-18 17:52:45 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs synopses: use ellipsis with singular words

Browse Source 
We use plural "*OPTIONS*" more often than "*OPTION*...", so let's do
that everywhere.

In some other places where we do have an ellipsis, make sure to use
singular, since the ellipsis already means repetition.  This change
is incomplete, and I'm not sure if this is worth it, since it's
subjective, so I might drop it.
This commit is contained in:
Johannes Altmanninger 2022-01-09 09:42:36 +01:00
parent f8e8c23ac3
commit be451091d4
6 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc_src/cmds/block.rst
View File

@ -6,7 +6,7 @@ block - temporarily block delivery of events
Synopsis Synopsis
-------- --------
**block** [*OPTIONS* ...] **block** [*OPTIONS*]
Description Description
----------- -----------

4
doc_src/cmds/builtin.rst
View File

@ -6,8 +6,8 @@ builtin - run a builtin command
Synopsis Synopsis
-------- --------
| **builtin** [*OPTIONS* ...] *BUILTINNAME* | **builtin** [*OPTIONS*] *BUILTINNAME*
| **builtin** --query *BUILTINNAMES* ... | **builtin** --query *BUILTINNAME* ...
Description Description
----------- -----------

4
doc_src/cmds/fish.rst
View File

@ -7,8 +7,8 @@ fish - the friendly interactive shell
Synopsis Synopsis
-------- --------
| ``fish`` [*OPTIONS*] [*FILE* [ARGS ...]] | ``fish`` [*OPTIONS*] [*FILE* [ARG ...]]
| ``fish`` [*OPTIONS*] [**-c** *COMMAND* [ARGS ...]] | ``fish`` [*OPTIONS*] [**-c** *COMMAND* [ARG ...]]
Description Description
----------- -----------

2
doc_src/cmds/functions.rst
View File

@ -10,7 +10,7 @@ Synopsis
| **functions** [ **-D** | **--details** ] [ **-v** ] *FUNCTION* | **functions** [ **-D** | **--details** ] [ **-v** ] *FUNCTION*
| **functions** **-c** *OLDNAME* *NEWNAME* | **functions** **-c** *OLDNAME* *NEWNAME*
| **functions** **-d** *DESCRIPTION* *FUNCTION* | **functions** **-d** *DESCRIPTION* *FUNCTION*
| **functions** [ **-e** | **-q** ] *FUNCTIONS...* | **functions** [ **-e** | **-q** ] *FUNCTION...*
Description Description
----------- -----------

2
doc_src/cmds/while.rst
View File

@ -6,7 +6,7 @@ while - perform a set of commands multiple times
Synopsis Synopsis
-------- --------
**while** *CONDITION*; *COMMANDS...*; **end** **while** *CONDITION*; *COMMANDS*; **end**
Description Description
----------- -----------

2
doc_src/language.rst
View File

@ -1207,7 +1207,7 @@ A more robust approach to argument handling is :ref:`argparse <cmd-argparse>`, w
# If -h or --help is given, we print a little help text and return # If -h or --help is given, we print a little help text and return
if set -q _flag_help if set -q _flag_help
echo "mybetterfunction [-h|--help] [-s|--second] [ARGUMENTS...]" echo "mybetterfunction [-h|--help] [-s|--second] [ARGUMENT...]"
return 0 return 0
end end