diff options
| author |  Mark Griffiths <mark@thebespokepixel.com> | 2014-08-19 13:41:23 +0100 |
|---|---|---|
| committer | Mark Griffiths <mark@thebespokepixel.com> | 2014-09-03 14:43:26 +0100 |
| commit | 137abd0cfaa8959224f88a4ebe9584a51468cc88 (patch) | |
| tree | c396f760a1e309b5a837359e65c57c4555534d49 /doc_src/return.txt | |
| parent | d7308fecbe573aad91fc6f1377c1ed2df735f6fd (diff) | |
Make line length, wrapping and spacing consistent
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 |