fish-shell/doc_src/cmds/end.rst

.. _cmd-end:

end - end a block of commands
=============================

Synopsis
--------

| **begin**
|     [*COMMANDS*...] 
| **end**

| **function** *NAME* [*OPTIONS*]; *COMMANDS*...; **end**
| **if** *CONDITION*; *COMMANDS_TRUE*...; [**else**; *COMMANDS_FALSE*...;] **end**
| **switch** *VALUE*; [**case** [*WILDCARD*...]; [*COMMANDS*...]; ...] **end**
| **while** *CONDITION*; *COMMANDS*...; **end**
| **for** *VARNAME* in [*VALUES*...]; **COMMANDS**...; **end**

Description
-----------

The **end** keyword ends a block of commands started by one of the following commands:

- :ref:`begin <cmd-begin>` to start a block of commands
- :ref:`function <cmd-function>` to define a function
- :ref:`if <cmd-if>`, :ref:`switch <cmd-switch>` to conditionally execute commands
- :ref:`while <cmd-while>`, :ref:`for <cmd-for>` to perform commands multiple times

The **end** keyword does not change the current exit status.
Instead, the status after it will be the status returned by the most recent command.
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 09:05:09 +00:00			`.. _cmd-end:`

doc: homogenize commands titles 2020-03-31 15:37:38 +00:00			`end - end a block of commands`
			`=============================`
Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Commit doc_src progress. This is continuing the work I've been doing to remove the :: formatting for the synopsis sections of our manual pages. 2021-12-17 21:58:38 +00:00			`\| begin`
			`\| [COMMANDS...]`
			`\| end`
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00
Commit doc_src progress. This is continuing the work I've been doing to remove the :: formatting for the synopsis sections of our manual pages. 2021-12-17 21:58:38 +00:00			`\| function NAME [OPTIONS]; COMMANDS...; end`
			`\| if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end`
			`\| switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end`
			`\| while CONDITION; COMMANDS...; end`
			`\| for VARNAME in [VALUES...]; COMMANDS...; end`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Description`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Commit doc_src progress. This is continuing the work I've been doing to remove the :: formatting for the synopsis sections of our manual pages. 2021-12-17 21:58:38 +00:00			`The end keyword ends a block of commands started by one of the following commands:`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
doc(end): mention the 'function' command and add links to all block starters 2020-03-04 21:06:57 +00:00			- :ref:`begin <cmd-begin>` to start a block of commands
			- :ref:`function <cmd-function>` to define a function
			- :ref:`if <cmd-if>`, :ref:`switch <cmd-switch>` to conditionally execute commands
			- :ref:`while <cmd-while>`, :ref:`for <cmd-for>` to perform commands multiple times
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Commit doc_src progress. This is continuing the work I've been doing to remove the :: formatting for the synopsis sections of our manual pages. 2021-12-17 21:58:38 +00:00			`The end keyword does not change the current exit status.`
			`Instead, the status after it will be the status returned by the most recent command.`