blob: 997d60a3d85ac68861a42237e56ae0db9625250a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
\section return return - Stop the innermost currently evaluated function
\subsection return-synopsis Synopsis
<tt>function NAME; [COMMANDS...] break [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 href="#if">if</a> statement or a
<a href="#switch">switch</a> statement to conditionally stop the
executing function and return to the caller.
- \c STATUS is the return status of the function. If unspecified, the status is set to 0.
\subsection return-example Example
The following code is an implementation of the false program as a fish builtin
<p>
<pre>function false
return 1
end</pre>
</p>
|