diff options
Diffstat (limited to 'doc_src/return.txt')
-rw-r--r-- | doc_src/return.txt | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/doc_src/return.txt b/doc_src/return.txt index 5f033349..af4ca9ae 100644 --- a/doc_src/return.txt +++ b/doc_src/return.txt @@ -7,16 +7,13 @@ function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end \subsection return-description Description -`return` halts a currently running function. The exit status is set -to `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 \fish |