mirror of
https://github.com/fish-shell/fish-shell
synced 2024-09-21 15:01:53 +00:00
1287b9d823
Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while.
26 lines
748 B
Text
26 lines
748 B
Text
\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
|
|
|
|
\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.
|
|
|
|
\subsection return-example Example
|
|
The following code is an implementation of the false command as a fish function
|
|
|
|
<pre>
|
|
function false
|
|
return 1
|
|
end
|
|
</pre>
|
|
|
|
|