Help: Remove "this command" ambiguity in set() docs

This commit is contained in:
FeRD (Frank Dana) 2023-08-30 14:35:04 -04:00 committed by Craig Scott
parent 9eecdc7ab7
commit 2f319c6484
No known key found for this signature in database
GPG Key ID: 6FF37CBDCCADED9F

View File

@ -27,11 +27,12 @@ Set Normal Variable
If the ``PARENT_SCOPE`` option is given the variable will be set in
the scope above the current scope. Each new directory or :command:`function`
command creates a new scope. A scope can also be created with the
:command:`block` command. This command will set the value of a variable into
the parent directory, calling function or encompassing scope (whichever is
applicable to the case at hand). The previous state of the variable's value
stays the same in the current scope (e.g., if it was undefined before, it is
still undefined and if it had a value, it is still that value).
:command:`block` command. ``set(PARENT_SCOPE)`` will set the value
of a variable into the parent directory, calling function, or
encompassing scope (whichever is applicable to the case at hand).
The previous state of the variable's value stays the same in the
current scope (e.g., if it was undefined before, it is still undefined
and if it had a value, it is still that value).
The :command:`block(PROPAGATE)` and :command:`return(PROPAGATE)` commands
can be used as an alternate method to the :command:`set(PARENT_SCOPE)`