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
-----------

``end`` 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`` command 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 17:05:09 +08:00			`.. _cmd-end:`

doc: homogenize commands titles 2020-03-31 23:37:38 +08:00			`end - end a block of commands`
			`=============================`
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 17:59:04 +08:00			`::`
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 17:59:04 +08:00			`begin; [COMMANDS...] end`
doc(end): mention the 'function' command and add links to all block starters 2020-03-05 05:06:57 +08:00			`function NAME [OPTIONS]; COMMANDS...; end`
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 17:59:04 +08:00			`if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end`
doc(end): mention the 'function' command and add links to all block starters 2020-03-05 05:06:57 +08:00			`switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end`
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 17:59:04 +08:00			`while CONDITION; COMMANDS...; end`
			`for VARNAME in [VALUES...]; COMMANDS...; end`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Description`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
doc(end): mention the 'function' command and add links to all block starters 2020-03-05 05:06:57 +08:00			``end`` 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-17 05:08:41 +08:00
doc(end): mention the 'function' command and add links to all block starters 2020-03-05 05:06:57 +08: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-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			The ``end`` command does not change the current exit status. Instead, the status after it will be the status returned by the most recent command.