diff options
| author |  axel <axel@liljencrantz.se> | 2005-09-20 23:31:55 +1000 |
|---|---|---|
| committer | axel <axel@liljencrantz.se> | 2005-09-20 23:31:55 +1000 |
| commit | 7ddecde54372c25fcf526e2d24807c5dac9800aa (patch) | |
| tree | 1bff6e0ccd096836adb74529d53a6debcf45375b /doc_src/return.txt | |
| parent | 149594f974350bb364a76c73b91b1d5ffddaa1fa (diff) | |
Add subdirectories
darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
Diffstat (limited to 'doc_src/return.txt')
| -rw-r--r-- | doc_src/return.txt | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc_src/return.txt b/doc_src/return.txt new file mode 100644 index 00000000..997d60a3 --- /dev/null +++ b/doc_src/return.txt @@ -0,0 +1,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> + |