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

string docs: format options and arguments in line with other pages

Browse Source 
There are a number of items which don't fit cleanly into the styles used in the
synopses, and have been left alone.
This commit is contained in:
David Adam
2022-03-12 22:22:00 +08:00
parent a6d484836e
commit 4bc6b36bed
14 changed files with 42 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc_src/cmds/string-pad.rst
View File

@@ -18,15 +18,15 @@ Description
.. BEGIN DESCRIPTION
``string pad`` extends each STRING to the given visible width by adding CHAR to the left. That means the width of all visible characters added together, excluding escape sequences and accounting for $fish_emoji_width and $fish_ambiguous_width. It is the amount of columns in a terminal the STRING occupies.
``string pad`` extends each *STRING* to the given visible width by adding *CHAR* to the left. That means the width of all visible characters added together, excluding escape sequences and accounting for :envvar:`fish_emoji_width` and :envvar:`fish_ambiguous_width`. It is the amount of columns in a terminal the *STRING* occupies.
The escape sequences reflect what *fish* knows about, and how it computes its output. Your terminal might support more escapes, or not support escape sequences that fish knows about.
The escape sequences reflect what fish knows about, and how it computes its output. Your terminal might support more escapes, or not support escape sequences that fish knows about.
If ``-r`` or ``--right`` is given, add the padding after a string.
If **-r** or **--right** is given, add the padding after a string.
If ``-c`` or ``--char`` is given, pad with CHAR instead of whitespace.
If **-c** or **--char** is given, pad with *CHAR* instead of whitespace.
The output is padded to the maximum width of all input strings. If ``-w`` or ``--width`` is given, use at least that.
The output is padded to the maximum width of all input strings. If **-w** or **--width** is given, use at least that.
.. END DESCRIPTION