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

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

@@ -18,9 +18,9 @@ Description
.. BEGIN DESCRIPTION
``string join`` joins its STRING arguments into a single string separated by SEP, which can be an empty string. Exit status: 0 if at least one join was performed, or 1 otherwise.
``string join`` joins its *STRING* arguments into a single string separated by *SEP*, which can be an empty string. Exit status: 0 if at least one join was performed, or 1 otherwise.
``string join0`` joins its STRING arguments into a single string separated by the zero byte (NUL), and adds a trailing NUL. This is most useful in conjunction with tools that accept NUL-delimited input, such as ``sort -z``. Exit status: 0 if at least one join was performed, or 1 otherwise.
``string join0`` joins its *STRING* arguments into a single string separated by the zero byte (NUL), and adds a trailing NUL. This is most useful in conjunction with tools that accept NUL-delimited input, such as ``sort -z``. Exit status: 0 if at least one join was performed, or 1 otherwise.
Because Unix uses NUL as the string terminator, passing the output of ``string join0`` as an *argument* to a command (via a :ref:`command substitution <expand-command-substitution>`) won't actually work. Fish will pass the correct bytes along, but the command won't be able to tell where the argument ends. This is a limitation of Unix' argument passing.