diff options
Diffstat (limited to 'doc_src/return.txt')
-rw-r--r-- | doc_src/return.txt | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/doc_src/return.txt b/doc_src/return.txt index 9563cf39..af4ca9ae 100644 --- a/doc_src/return.txt +++ b/doc_src/return.txt @@ -1,26 +1,25 @@ \section return return - stop the current inner function \subsection return-synopsis Synopsis -<tt>function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end</tt> +\fish{synopsis} +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> statement to conditionally stop the executing function and return to the caller, but it can also be used to specify the exit status of a function. -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> -statement to conditionally stop the executing function and return to -the caller, but it can also be used to specify the exit status of a -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 |