diff options
Diffstat (limited to 'doc_src/return.txt')
| -rw-r--r-- | doc_src/return.txt | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/doc_src/return.txt b/doc_src/return.txt index 9563cf39..a044e58a 100644 --- a/doc_src/return.txt +++ b/doc_src/return.txt @@ -1,12 +1,14 @@ \section return return - stop the current inner function \subsection return-synopsis Synopsis -<tt>function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end</tt> +\fish{syn} +function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end +\endfish \subsection return-description Description -\c return halts a currently running function. The exit status is set -to \c STATUS if it is given. +`return` halts a currently running function. The exit status is set +to `STATUS` if it is given. It is usually added inside of a conditional block such as an <a href="#if">if</a> statement or a <a href="#switch">switch</a> @@ -17,10 +19,10 @@ function. \subsection return-example Example The following code is an implementation of the false command as a fish function -<pre> +\fish function false - return 1 + return 1 end -</pre> +\endfish |