fish-shell/sphinx_doc_src/cmds/for.rst

for - perform a set of commands multiple times.
==========================================

Synopsis
--------

for VARNAME in [VALUES...]; COMMANDS...; end


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

`for` is a loop construct. It will perform the commands specified by `COMMANDS` multiple times. On each iteration, the local variable specified by `VARNAME` is assigned a new value from `VALUES`. If `VALUES` is empty, `COMMANDS` will not be executed at all. The `VARNAME` is visible when the loop terminates and will contain the last value assigned to it. If `VARNAME` does not already exist it will be set in the local scope. For our purposes if the `for` block is inside a function there must be a local variable with the same name. If the `for` block is not nested inside a function then global and universal variables of the same name will be used if they exist.

Example
------------


::

    for i in foo bar baz; echo $i; end
    
    # would output:
    foo
    bar
    baz


Notes
------------

The `VARNAME` was local to the for block in releases prior to 3.0.0. This means that if you did something like this:


::

    for var in a b c
        if break_from_loop
            break
        end
    end
    echo $var


The last value assigned to `var` when the loop terminated would not be available outside the loop. What `echo $var` would write depended on what it was set to before the loop was run. Likely nothing.
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`for - perform a set of commands multiple times.`
			`==========================================`

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
			`for VARNAME in [VALUES...]; COMMANDS...; end`
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00
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`
			`------------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`for` is a loop construct. It will perform the commands specified by `COMMANDS` multiple times. On each iteration, the local variable specified by `VARNAME` is assigned a new value from `VALUES`. If `VALUES` is empty, `COMMANDS` will not be executed at all. The `VARNAME` is visible when the loop terminates and will contain the last value assigned to it. If `VARNAME` does not already exist it will be set in the local scope. For our purposes if the `for` block is inside a function there must be a local variable with the same name. If the `for` block is not nested inside a function then global and universal variables of the same name will be used if they exist.

Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Example`
			`------------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00

Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00
			`::`

			`for i in foo bar baz; echo $i; end`

			`# would output:`
			`foo`
			`bar`
			`baz`

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			`Notes`
			`------------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			The `VARNAME` was local to the for block in releases prior to 3.0.0. This means that if you did something like this:

Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00

			`::`

			`for var in a b c`
			`if break_from_loop`
			`break`
			`end`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00			`end`
Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00			`echo $var`

Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			The last value assigned to `var` when the loop terminated would not be available outside the loop. What `echo $var` would write depended on what it was set to before the loop was run. Likely nothing.