From 5e3328ef1f5e325adc7f2aee0372b72066e93d6d Mon Sep 17 00:00:00 2001 From: Delapouite Date: Wed, 4 Mar 2020 22:06:57 +0100 Subject: [PATCH] doc(end): mention the 'function' command and add links to all block starters --- doc_src/cmds/end.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/doc_src/cmds/end.rst b/doc_src/cmds/end.rst index 286223ed4..829220787 100644 --- a/doc_src/cmds/end.rst +++ b/doc_src/cmds/end.rst @@ -9,17 +9,20 @@ 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 - switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end Description ----------- -``end`` ends a block of commands. +``end`` ends a block of commands started by one of the following commands: -For more information, read the -documentation for the block constructs, such as ``if``, ``for`` and ``while``. +- :ref:`begin ` to start a block of commands +- :ref:`function ` to define a function +- :ref:`if `, :ref:`switch ` to conditionally execute commands +- :ref:`while `, :ref:`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.