From 78101364c354e9f242cb2381320d6f784f63cc6d Mon Sep 17 00:00:00 2001 From: Johannes Altmanninger Date: Sun, 9 Jan 2022 10:00:47 +0100 Subject: [PATCH] docs synopses: remove unconventional spaces inside [] and () We usually write "[a | b]", not "[ a | b ]". --- doc_src/cmds/command.rst | 2 +- doc_src/cmds/disown.rst | 2 +- doc_src/cmds/fish_opt.rst | 4 ++-- doc_src/cmds/functions.rst | 6 +++--- doc_src/cmds/history.rst | 2 +- doc_src/cmds/jobs.rst | 2 +- doc_src/cmds/nextd.rst | 2 +- doc_src/cmds/prevd.rst | 2 +- doc_src/cmds/set.rst | 8 ++++---- 9 files changed, 15 insertions(+), 15 deletions(-) diff --git a/doc_src/cmds/command.rst b/doc_src/cmds/command.rst index 69b968106..598172169 100644 --- a/doc_src/cmds/command.rst +++ b/doc_src/cmds/command.rst @@ -6,7 +6,7 @@ command - run a program Synopsis -------- -**command** [ **OPTIONS** ] [*COMMANDNAME* [ARG ...]] +**command** [**OPTIONS**] [*COMMANDNAME* [ARG ...]] Description ----------- diff --git a/doc_src/cmds/disown.rst b/doc_src/cmds/disown.rst index 864fed62c..c6b972604 100644 --- a/doc_src/cmds/disown.rst +++ b/doc_src/cmds/disown.rst @@ -6,7 +6,7 @@ disown - remove a process from the list of jobs Synopsis -------- -``disown`` [ **PID** ... ] +``disown`` [**PID** ...] Description ----------- diff --git a/doc_src/cmds/fish_opt.rst b/doc_src/cmds/fish_opt.rst index 2e437a5a2..4ff8ac573 100644 --- a/doc_src/cmds/fish_opt.rst +++ b/doc_src/cmds/fish_opt.rst @@ -5,8 +5,8 @@ fish_opt - create an option spec for the argparse command Synopsis -------- -| ``fish_opt`` [ **--help** ] -| ``fish_opt`` [ (**-slor**, **--multiple-vals=**) *optname*] +| ``fish_opt`` [**--help**] +| ``fish_opt`` [(**-slor**, **--multiple-vals=**) *optname*] Description ----------- diff --git a/doc_src/cmds/functions.rst b/doc_src/cmds/functions.rst index 81cff7738..2bf3ac124 100644 --- a/doc_src/cmds/functions.rst +++ b/doc_src/cmds/functions.rst @@ -6,11 +6,11 @@ functions - print or erase functions Synopsis -------- -| **functions** [ **-a** | **--all** ] [ **-n** | **--names** ] -| **functions** [ **-D** | **--details** ] [ **-v** ] *FUNCTION* +| **functions** [**-a** | **--all**] [**-n** | **--names**] +| **functions** [**-D** | **--details**] [**-v**] *FUNCTION* | **functions** **-c** *OLDNAME* *NEWNAME* | **functions** **-d** *DESCRIPTION* *FUNCTION* -| **functions** [ **-e** | **-q** ] *FUNCTION ...* +| **functions** [**-e** | **-q**] *FUNCTION ...* Description ----------- diff --git a/doc_src/cmds/history.rst b/doc_src/cmds/history.rst index b8d5f5648..2f2572a11 100644 --- a/doc_src/cmds/history.rst +++ b/doc_src/cmds/history.rst @@ -8,7 +8,7 @@ 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 ...* | ``history`` **merge** diff --git a/doc_src/cmds/jobs.rst b/doc_src/cmds/jobs.rst index db4ebad76..0453247de 100644 --- a/doc_src/cmds/jobs.rst +++ b/doc_src/cmds/jobs.rst @@ -6,7 +6,7 @@ jobs - print currently running jobs Synopsis -------- -``jobs`` [*OPTIONS*] [ *PID* | %*JOBID* ] +``jobs`` [*OPTIONS*] [*PID* | %*JOBID*] Description diff --git a/doc_src/cmds/nextd.rst b/doc_src/cmds/nextd.rst index 66572b064..72f6d1b8b 100644 --- a/doc_src/cmds/nextd.rst +++ b/doc_src/cmds/nextd.rst @@ -6,7 +6,7 @@ nextd - move forward through directory history Synopsis -------- -``nextd`` [ **-l** | **--list** ] [*POS*] +``nextd`` [**-l** | **--list**] [*POS*] Description ----------- diff --git a/doc_src/cmds/prevd.rst b/doc_src/cmds/prevd.rst index 1214c6a36..2a1345b52 100644 --- a/doc_src/cmds/prevd.rst +++ b/doc_src/cmds/prevd.rst @@ -6,7 +6,7 @@ prevd - move backward through directory history Synopsis -------- -``prevd`` [ **-l** | **--list** ] [*POS*] +``prevd`` [**-l** | **--list**] [*POS*] Description ----------- diff --git a/doc_src/cmds/set.rst b/doc_src/cmds/set.rst index 4be28cfe4..d0c36871e 100644 --- a/doc_src/cmds/set.rst +++ b/doc_src/cmds/set.rst @@ -9,10 +9,10 @@ Synopsis | ``set`` [*scope options*] | ``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`` (**-q** | **--query**) [*scope options*] *VARIABLE* ... +| ``set`` (**-e** | **--erase**) [*scope options*] *VARIABLE* ... +| ``set`` (**-e** | **--erase**) [*scope options*] *VARIABLE*\[*INDICES*] ... +| ``set`` (**-S** | **--show**) *VARIABLE* ... Description -----------