fish/doc_src/return.txt

\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>
Help cleanup 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. 2013-05-12 15:56:01 +08:00			`\section return return - stop the current inner function`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 23:31:55 +10:00
			`\subsection return-synopsis Synopsis`
Documentation updates from Beni Cherniavsky darcs-hash:20060919145203-ac50b-bc87b8f5e6a18395e4bc3e364da4a40ad97850e7.gz 2006-09-20 00:52:03 +10:00			`<tt>function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end</tt>`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 23:31:55 +10:00
remove trialing spaces #2 2010-09-18 10:18:26 +08:00			`\subsection return-description Description`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 23:31:55 +10:00
Help cleanup 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. 2013-05-12 15:56:01 +08:00			`\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`
Do not change status when the 'return' builtin is called with no argument darcs-hash:20060612164854-ac50b-5f428c819e8dafb44b591150d1965c5158854781.gz 2006-06-13 02:48:54 +10:00			`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.`

Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 23:31:55 +10:00			`\subsection return-example Example`
Many minor edits and clarifications to the documentation, including comments about the exit status of a few commands darcs-hash:20060603231517-ac50b-03d252516eef21d4dd3a2ba0f5bb68e82525213b.gz 2006-06-04 09:15:17 +10:00			`The following code is an implementation of the false command as a fish function`
Documentation updates from Beni Cherniavsky darcs-hash:20060919145203-ac50b-bc87b8f5e6a18395e4bc3e364da4a40ad97850e7.gz 2006-09-20 00:52:03 +10:00
			`<pre>`
			`function false`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 23:31:55 +10:00			`return 1`
Documentation updates from Beni Cherniavsky darcs-hash:20060919145203-ac50b-bc87b8f5e6a18395e4bc3e364da4a40ad97850e7.gz 2006-09-20 00:52:03 +10:00			`end`
			`</pre>`

Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 23:31:55 +10:00