Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-11-10 15:14:44 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs synopses: fix alignment of continuation lines

Browse source 
This corrects what looks like wrong alignment of some synopsis lines.
(I think the alignment is not a bad idea but it makes us do more
manual work, maybe we can automate that in future.  We still need to
figure out how to translate it to HTML.)

"man -l build/user_doc/man/man1/history.1" before:

	string match [-a | --all] [-e | --entire] [-i | --ignore-case]
	            [-r | --regex] [-n | --index] [-q | --quiet] [-v | --invert]
	            PATTERN [STRING…]

and after:

	string match [-a | --all] [-e | --entire] [-i | --ignore-case]
	             [-r | --regex] [-n | --index] [-q | --quiet] [-v | --invert]
	             PATTERN [STRING…]

Also make the lines align the same way in the RST source by carefully
choosing the position of the backslash. I'm not sure why we used
two backslashes per line. Use only one; this gives us no choice
of where to put it so both source and man page output are aligned.
Change tabs to spaces to make the alignment in the source work.
This commit is contained in:
Johannes Altmanninger 2022-01-09 11:03:31 +01:00
parent 18467457c6
commit 97db9d5c38
9 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc_src/cmds/history.rst
View file

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

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

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

16
doc_src/cmds/string.rst
View file

@ -13,22 +13,22 @@ Synopsis
| ``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* ...]
\ [**-r** | **--regex**] [**-n** | **--index**] [**-q** | **--quiet**] [**-v** | **--invert**]
\ *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* ...]
| ``string`` trim [**-l** | **--left**] [**-r** | **--right**] [(**-c** | **--chars**) *CHARS*]
\ \ [**-q** | **--quiet**] [*STRING* ...]
\ [**-q** | **--quiet**] [*STRING* ...]
| ``string`` unescape [**--style=**] [*STRING* ...]
| ``string`` upper [**-q** | **--quiet**] [*STRING* ...]