fish-shell/sphinx_doc_src/cmds/end.rst
David Adam 02d82dcf85 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

25 lines
664 B
ReStructuredText

.. _cmd-end:
end - end a block of commands.
==============================
Synopsis
--------
::
begin; [COMMANDS...] end
if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end
while CONDITION; COMMANDS...; end
for VARNAME in [VALUES...]; COMMANDS...; end
switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end
Description
-----------
``end`` ends a block of commands.
For more information, read the
documentation for the block constructs, such as ``if``, ``for`` and ``while``.
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.