Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2025-01-14 05:53:59 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs synopses: add space before ellipsis

Browse source 
This matches the style in man(1) (except that we use the … ligature).

A previous iteration did the reverse (never use a space before the
ellipsis). That would be a smaller change.
This commit is contained in:
Johannes Altmanninger 2022-01-09 09:49:51 +01:00
parent be451091d4
commit ad4530acd3
37 changed files with 66 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc_src/cmds/abbr.rst
View file

@ -38,7 +38,7 @@ The following options are available:
**-l** or **--list**
Lists all abbreviated words
**-e** *WORD* or **--erase** *WORD*...
**-e** *WORD* or **--erase** *WORD* ...
Erase the given abbreviations
**-q** or **--query**

2
doc_src/cmds/argparse.rst
View file

@ -6,7 +6,7 @@ argparse - parse options passed to a fish script or function
Synopsis
--------
``argparse`` [*OPTIONS*] *OPTION_SPEC*... -- [*ARG*...]
``argparse`` [*OPTIONS*] *OPTION_SPEC* ... -- [*ARG* ...]
Description

2
doc_src/cmds/case.rst
View file

@ -7,7 +7,7 @@ Synopsis
--------
| **switch** *VALUE*
| [**case** [*GLOB*...]
| [**case** [*GLOB* ...]
| [*COMMAND* ...]]
| **end**

2
doc_src/cmds/continue.rst
View file

@ -6,7 +6,7 @@ continue - skip the remainder of the current iteration of the current inner loop
Synopsis
--------
**LOOP_CONSTRUCT**; [*COMMANDS*...;] **continue**; [*COMMANDS*...;] **end**
**LOOP_CONSTRUCT**; [*COMMANDS* ...;] **continue**; [*COMMANDS* ...;] **end**
Description
-----------

2
doc_src/cmds/count.rst
View file

@ -6,7 +6,7 @@ count - count the number of elements of a list
Synopsis
--------
| ``count`` string1 string2...
| ``count`` string1 string2 ...
| *command* | ``count``
| ``count`` [...] < *FILE*

2
doc_src/cmds/else.rst
View file

@ -6,7 +6,7 @@ else - execute command if a condition is not met
Synopsis
--------
**if** *CONDITION*; *COMMANDS_TRUE*...; [**else**; *COMMANDS_FALSE*...;] **end**
**if** *CONDITION*; *COMMANDS_TRUE* ...; [**else**; *COMMANDS_FALSE* ...;] **end**
Description
-----------

2
doc_src/cmds/emit.rst
View file

@ -6,7 +6,7 @@ emit - emit a generic event
Synopsis
--------
``emit`` *EVENT_NAME* [*ARGUMENTS*...]
``emit`` *EVENT_NAME* [*ARGUMENTS* ...]
Description
-----------

12
doc_src/cmds/end.rst
View file

@ -7,14 +7,14 @@ Synopsis
--------
| **begin**
| [*COMMANDS*...]
| [*COMMANDS* ...]
| **end**
| **function** *NAME* [*OPTIONS*]; *COMMANDS*...; **end**
| **if** *CONDITION*; *COMMANDS_TRUE*...; [**else**; *COMMANDS_FALSE*...;] **end**
| **switch** *VALUE*; [**case** [*WILDCARD*...]; [*COMMANDS*...]; ...] **end**
| **while** *CONDITION*; *COMMANDS*...; **end**
| **for** *VARNAME* in [*VALUES*...]; **COMMANDS**...; **end**
| **function** *NAME* [*OPTIONS*]; *COMMANDS* ...; **end**
| **if** *CONDITION*; *COMMANDS_TRUE* ...; [**else**; *COMMANDS_FALSE* ...;] **end**
| **switch** *VALUE*; [**case** [*WILDCARD* ...]; [*COMMANDS* ...]; ...] **end**
| **while** *CONDITION*; *COMMANDS* ...; **end**
| **for** *VARNAME* in [*VALUES* ...]; **COMMANDS** ...; **end**
Description
-----------

2
doc_src/cmds/eval.rst
View file

@ -6,7 +6,7 @@ eval - evaluate the specified commands
Synopsis
--------
**eval** [*COMMANDS*...]
**eval** [*COMMANDS* ...]
Description
-----------

4
doc_src/cmds/fish_add_path.rst
View file

@ -7,8 +7,8 @@ fish_add_path - add to the path
Synopsis
--------
| ``fish_add_path`` *path*...
| ``fish_add_path`` [(*-g* | *--global*) | (*-U* | *--universal*) | (*-P* | *--path*)] [(*-m* | *--move*)] [(*-a* | *--append*) | (*-p* | *--prepend*)] [(*-v* | *--verbose*) | (*-n* | *--dry-run*)] *paths*...
| ``fish_add_path`` *path* ...
| ``fish_add_path`` [(*-g* | *--global*) | (*-U* | *--universal*) | (*-P* | *--path*)] [(*-m* | *--move*)] [(*-a* | *--append*) | (*-p* | *--prepend*)] [(*-v* | *--verbose*) | (*-n* | *--dry-run*)] *paths* ...
Description

2
doc_src/cmds/fish_indent.rst
View file

@ -7,7 +7,7 @@ fish_indent - indenter and prettifier
Synopsis
--------
**fish_indent** [*OPTIONS*] [*FILE*...]
**fish_indent** [*OPTIONS*] [*FILE* ...]
Description

2
doc_src/cmds/for.rst
View file

@ -6,7 +6,7 @@ for - perform a set of commands multiple times
Synopsis
--------
**for** *VARNAME* in [*VALUES*...]; *COMMANDS*...; **end**
**for** *VARNAME* in [*VALUES* ...]; *COMMANDS* ...; **end**
Description
-----------

2
doc_src/cmds/functions.rst
View file

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

4
doc_src/cmds/history.rst
View file

@ -8,9 +8,9 @@ Synopsis
| ``history`` [**search**] [**--show-time**] [**--case-sensitive**]
\ \ [**--exact** | **--prefix** | **--contains**] [**--max** *n*] [**--null**] [**--reverse**]
\ \ [ *SEARCH_STRING...* ]
\ \ [ *SEARCH_STRING ...* ]
| ``history`` **delete** [**--case-sensitive**]
\ \ [**--exact** | **--prefix** | **--contains**] *SEARCH_STRING...*
\ \ [**--exact** | **--prefix** | **--contains**] *SEARCH_STRING ...*
| ``history`` **merge**
| ``history`` **save**
| ``history`` **clear**

6
doc_src/cmds/if.rst
View file

@ -6,9 +6,9 @@ if - conditionally execute a command
Synopsis
--------
| **if** *CONDITION*; *COMMANDS_TRUE*...;
| [**else** **if** *CONDITION2*; *COMMANDS_TRUE2*...;]
| [**else**; *COMMANDS_FALSE*...;]
| **if** *CONDITION*; *COMMANDS_TRUE* ...;
| [**else** **if** *CONDITION2*; *COMMANDS_TRUE2* ...;]
| [**else**; *COMMANDS_FALSE* ...;]
| **end**
Description

2
doc_src/cmds/math.rst
View file

@ -6,7 +6,7 @@ math - perform mathematics calculations
Synopsis
--------
``math`` [(**-s** | **--scale**) *N*] [(**-b** | **--base**) *BASE*] *EXPRESSION...*
``math`` [(**-s** | **--scale**) *N*] [(**-b** | **--base**) *BASE*] *EXPRESSION ...*
Description

2
doc_src/cmds/not.rst
View file

@ -6,7 +6,7 @@ not - negate the exit status of a job
Synopsis
--------
**not** *COMMAND* [*options*...]
**not** *COMMAND* [*options* ...]
Description

2
doc_src/cmds/open.rst
View file

@ -6,7 +6,7 @@ open - open file in its default application
Synopsis
--------
``open`` *FILES*...
``open`` *FILES* ...
Description

2
doc_src/cmds/random.rst
View file

@ -10,7 +10,7 @@ Synopsis
| ``random`` *SEED*
| ``random`` *START* *END*
| ``random`` *START* *STEP* *END*
| ``random`` choice [*ITEMS*...]
| ``random`` choice [*ITEMS* ...]
Description
-----------

6
doc_src/cmds/set.rst
View file

@ -7,12 +7,12 @@ Synopsis
--------
| ``set`` [*scope options*]
| ``set`` [*options*] *VARIABLE* *VALUES*...
| ``set`` [*options*] *VARIABLE*\[*INDICES*] *VALUES*...
| ``set`` [*options*] *VARIABLE* *VALUES* ...
| ``set`` [*options*] *VARIABLE*\[*INDICES*] *VALUES* ...
| ``set`` ( **-q** | **--query** ) [*scope options*] *VARIABLE* ...
| ``set`` ( **-e** | **--erase** ) [*scope options*] *VARIABLE* ...
| ``set`` ( **-e** | **--erase** ) [*scope options*] *VARIABLE*\[*INDICES*] ...
| ``set`` ( **-S** | **--show** ) *VARIABLE*...
| ``set`` ( **-S** | **--show** ) *VARIABLE* ...
Description
-----------

2
doc_src/cmds/source.rst
View file

@ -6,7 +6,7 @@ source - evaluate contents of file
Synopsis
--------
| **source** *FILE* [*arguments*...]
| **source** *FILE* [*arguments* ...]
| ``somecommand`` | **source**

2
doc_src/cmds/string-collect.rst
View file

@ -6,7 +6,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` collect [**-N** | **--no-trim-newlines**] [*STRING*...]
``string`` collect [**-N** | **--no-trim-newlines**] [*STRING* ...]
.. END SYNOPSIS

4
doc_src/cmds/string-escape.rst
View file

@ -6,8 +6,8 @@ Synopsis
.. BEGIN SYNOPSIS
| ``string`` escape [**-n** | **--no-quoted**] [**--style=**] [*STRING*...]
| ``string`` unescape [**--style=**] [*STRING*...]
| ``string`` escape [**-n** | **--no-quoted**] [**--style=**] [*STRING* ...]
| ``string`` unescape [**--style=**] [*STRING* ...]
.. END SYNOPSIS

4
doc_src/cmds/string-join.rst
View file

@ -6,8 +6,8 @@ Synopsis
.. BEGIN SYNOPSIS
| ``string`` join [**-q** | **--quiet**] SEP [*STRING*...]
| ``string`` join0 [**-q** | **--quiet**] [*STRING*...]
| ``string`` join [**-q** | **--quiet**] SEP [*STRING* ...]
| ``string`` join0 [**-q** | **--quiet**] [*STRING* ...]
.. END SYNOPSIS

2
doc_src/cmds/string-length.rst
View file

@ -8,7 +8,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` length [**-q** | **--quiet**] [*STRING*...]
``string`` length [**-q** | **--quiet**] [*STRING* ...]
.. END SYNOPSIS

2
doc_src/cmds/string-lower.rst
View file

@ -6,7 +6,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` lower [**-q** | **--quiet**] [*STRING*...]
``string`` lower [**-q** | **--quiet**] [*STRING* ...]
.. END SYNOPSIS

2
doc_src/cmds/string-match.rst
View file

@ -8,7 +8,7 @@ Synopsis
``string`` match [**-a** | **--all**] [**-e** | **--entire**] [**-i** | **--ignore-case**]
\ \ [**-r** | **--regex**] [**-n** | **--index**] [**-q** | **--quiet**] [**-v** | **--invert**]
\ \ *PATTERN* [*STRING*...]
\ \ *PATTERN* [*STRING* ...]
.. END SYNOPSIS

2
doc_src/cmds/string-pad.rst
View file

@ -7,7 +7,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` pad [**-r** | **--right**] [(**-c** | **--char**) *CHAR*] [(**-w** | **--width**) *INTEGER*]
\ \ [*STRING*...]
\ \ [*STRING* ...]
.. END SYNOPSIS

2
doc_src/cmds/string-repeat.rst
View file

@ -7,7 +7,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` repeat [(**-n** | **--count**) *COUNT*] [(**-m** | **--max**) *MAX*] [**-N** | **--no-newline**]
\ \ [**-q** | **--quiet**] [*STRING*...]
\ \ [**-q** | **--quiet**] [*STRING* ...]
.. END SYNOPSIS

2
doc_src/cmds/string-replace.rst
View file

@ -7,7 +7,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` replace [**-a** | **--all**] [**-f** | **--filter**] [**-i** | **--ignore-case**]
\ \ [**-r** | **--regex**] [**-q** | **--quiet**] *PATTERN* *REPLACE* [*STRING*...]
\ \ [**-r** | **--regex**] [**-q** | **--quiet**] *PATTERN* *REPLACE* [*STRING* ...]
.. END SYNOPSIS

4
doc_src/cmds/string-split.rst
View file

@ -7,9 +7,9 @@ Synopsis
.. BEGIN SYNOPSIS
| ``string`` split [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**]
\ \ [**-r** | **--right**] *SEP* [*STRING*...]
\ \ [**-r** | **--right**] *SEP* [*STRING* ...]
| ``string`` split0 [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**]
\ \ [**-r** | **--right**] [*STRING*...]
\ \ [**-r** | **--right**] [*STRING* ...]
.. END SYNOPSIS

2
doc_src/cmds/string-sub.rst
View file

@ -7,7 +7,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` sub [(**-s** | **--start**) *START*] [(**-l** | **--length**) *LENGTH*]
\ [**-q** | **--quiet**] [*STRING*...]
\ [**-q** | **--quiet**] [*STRING* ...]
.. END SYNOPSIS

2
doc_src/cmds/string-trim.rst
View file

@ -7,7 +7,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` trim [**-l** | **--left**] [**-r** | **--right**] [(**-c** | **--chars**) *CHARS*]
\ \ [**-q** | **--quiet**] [*STRING*...]
\ \ [**-q** | **--quiet**] [*STRING* ...]
.. END SYNOPSIS

2
doc_src/cmds/string-upper.rst
View file

@ -6,7 +6,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` upper [**-q** | **--quiet**] [*STRING*...]
``string`` upper [**-q** | **--quiet**] [*STRING* ...]
.. END SYNOPSIS

32
doc_src/cmds/string.rst
View file

@ -6,31 +6,31 @@ string - manipulate strings
Synopsis
--------
| ``string`` collect [**-N** | **--no-trim-newlines**] [*STRING*...]
| ``string`` escape [**-n** | **--no-quoted**] [**--style=**] [*STRING*...]
| ``string`` join [**-q** | **--quiet**] SEP [*STRING*...]
| ``string`` join0 [**-q** | **--quiet**] [*STRING*...]
| ``string`` length [**-q** | **--quiet**] [*STRING*...]
| ``string`` lower [**-q** | **--quiet**] [*STRING*...]
| ``string`` collect [**-N** | **--no-trim-newlines**] [*STRING* ...]
| ``string`` escape [**-n** | **--no-quoted**] [**--style=**] [*STRING* ...]
| ``string`` join [**-q** | **--quiet**] SEP [*STRING* ...]
| ``string`` join0 [**-q** | **--quiet**] [*STRING* ...]
| ``string`` length [**-q** | **--quiet**] [*STRING* ...]
| ``string`` lower [**-q** | **--quiet**] [*STRING* ...]
| ``string`` match [**-a** | **--all**] [**-e** | **--entire**] [**-i** | **--ignore-case**]
\ \ [**-r** | **--regex**] [**-n** | **--index**] [**-q** | **--quiet**] [**-v** | **--invert**]
\ \ *PATTERN* [*STRING*...]
\ \ *PATTERN* [*STRING* ...]
| ``string`` pad [**-r** | **--right**] [**-c** | **--char** *CHAR*] [**-w** | **--width** *INTEGER*]
\ \ [*STRING*...]
\ \ [*STRING* ...]
| ``string`` repeat [(**-n** | **--count**) *COUNT*] [(**-m** | **--max**) *MAX*] [**-N** | **--no-newline**]
\ \ [**-q** | **--quiet**] [*STRING*...]
\ \ [**-q** | **--quiet**] [*STRING* ...]
| ``string`` replace [**-a** | **--all**] [**-f** | **--filter**] [**-i** | **--ignore-case**]
\ \ [**-r** | **--regex**] [**-q** | **--quiet**] *PATTERN* *REPLACE* [*STRING*...]
\ \ [**-r** | **--regex**] [**-q** | **--quiet**] *PATTERN* *REPLACE* [*STRING* ...]
| ``string`` split [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**]
\ \ [**-r** | **--right**] *SEP* [*STRING*...]
\ \ [**-r** | **--right**] *SEP* [*STRING* ...]
| ``string`` split0 [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**]
\ \ [**-r** | **--right**] [*STRING*...]
\ \ [**-r** | **--right**] [*STRING* ...]
| ``string`` sub [(**-s** | **--start**) *START*] [(**-l** | **--length**) *LENGTH*]
\ [**-q** | **--quiet**] [*STRING*...]
\ [**-q** | **--quiet**] [*STRING* ...]
| ``string`` trim [**-l** | **--left**] [**-r** | **--right**] [(**-c** | **--chars**) *CHARS*]
\ \ [**-q** | **--quiet**] [*STRING*...]
| ``string`` unescape [**--style=**] [*STRING*...]
| ``string`` upper [**-q** | **--quiet**] [*STRING*...]
\ \ [**-q** | **--quiet**] [*STRING* ...]
| ``string`` unescape [**--style=**] [*STRING* ...]
| ``string`` upper [**-q** | **--quiet**] [*STRING* ...]
Description
-----------

2
doc_src/cmds/switch.rst
View file

@ -6,7 +6,7 @@ switch - conditionally execute a block of commands
Synopsis
--------
**switch** *VALUE*; [**case** [*GLOB*...]; [*COMMANDS*...]; ...] **end**
**switch** *VALUE*; [**case** [*GLOB* ...]; [*COMMANDS* ...]; ...] **end**
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 set -q _flag_help
echo "mybetterfunction [-h|--help] [-s|--second] [ARGUMENT...]"
echo "mybetterfunction [-h|--help] [-s|--second] [ARGUMENT ...]"
return 0
end