diff options
| author |  axel <axel@liljencrantz.se> | 2006-06-04 09:15:17 +1000 |
|---|---|---|
| committer | axel <axel@liljencrantz.se> | 2006-06-04 09:15:17 +1000 |
| commit | 6fd69bdda8b4d185fb636047ab8914989fc66252 (patch) | |
| tree | 50883b516a46dec263490a0b20fb6319689e4956 /doc_src/return.txt | |
| parent | a85f4cc1c48052487b2c258cb01748597be927a5 (diff) | |
Many minor edits and clarifications to the documentation, including comments about the exit status of a few commands
darcs-hash:20060603231517-ac50b-03d252516eef21d4dd3a2ba0f5bb68e82525213b.gz
Diffstat (limited to 'doc_src/return.txt')
| -rw-r--r-- | doc_src/return.txt | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc_src/return.txt b/doc_src/return.txt index 997d60a3..005ca360 100644 --- a/doc_src/return.txt +++ b/doc_src/return.txt @@ -8,12 +8,13 @@ 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. +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 set to 0. \subsection return-example Example -The following code is an implementation of the false program as a fish builtin +The following code is an implementation of the false command as a fish function <p> <pre>function false return 1 |