diff options
Diffstat (limited to 'doc_src/return.txt')
| -rw-r--r-- | doc_src/return.txt | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc_src/return.txt b/doc_src/return.txt index 2cfd5ab6..9563cf39 100644 --- a/doc_src/return.txt +++ b/doc_src/return.txt @@ -1,19 +1,19 @@ -\section return return - stop the innermost currently evaluated function +\section return return - stop the current inner function \subsection return-synopsis Synopsis <tt>function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end</tt> \subsection return-description Description -The \c return builtin is used to halt a currently running function. It -is usually added inside of a conditional block such as an <a +\c return halts a currently running function. The exit status is set +to \c 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. -- \c STATUS is the return status of the function. If unspecified, the status is unchanged. - \subsection return-example Example The following code is an implementation of the false command as a fish function |