Mercurial > hgrepos > Python > libs > ConfigMix
diff doc/introduction.rst @ 202:2e66178a09d8
Docu: Ban "keyword expansion" -- use "variable interpolation" instead
"Variable interpolation" or "variable expansion" or "variable substitution"
are the proper wordings.
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Sun, 05 May 2019 12:07:27 +0200 |
| parents | c6904d02beae |
| children | fa660f084ceb |
line wrap: on
line diff
--- a/doc/introduction.rst Sun May 05 12:01:33 2019 +0200 +++ b/doc/introduction.rst Sun May 05 12:07:27 2019 +0200 @@ -201,7 +201,7 @@ Getting configuration variables ------------------------------- -Get a -- possibly expanded -- configuration variable's value with:: +Get a -- possibly interpolated -- configuration variable's value with:: value1 = config.getvar_s("key1") @@ -220,7 +220,7 @@ This is true for both methods :py:meth:`.Configuration.getvar` and :py:meth:`.Configuration.getvar_s`. -Both methods also perform :ref:`variable-expansion` and handle +Both methods also perform :ref:`variable-interpolation` and handle :ref:`variable-namespaces`. Filtering is not supported. So -- the variable name arguments of :py:meth:`.Configuration.getvar` and :py:meth:`.Configuration.getvar_s` are of the form @@ -291,14 +291,14 @@ yields the current working directory as :py:func:`os.getcwd` does. -.. _variable-expansion: +.. _variable-interpolation: -Variable Expansion ------------------- +Variable Interpolation +---------------------- Configuration variable values that are read with :py:meth:`.Configuration.getvar_s` are subject to variable -expansion. The general syntactic pattern for this is:: +interpolation. The general syntactic pattern for this is:: {{[namespace:]variable[|filter[|filter...]]}} @@ -306,7 +306,7 @@ a colon ``:``, the `variable` and then zero or more filters, each one introduced by a pipe symbol ``|``. -Variables are expanded lately at runtime -- exactly when calling +Variables are expanded *lately* at runtime -- exactly when calling :py:meth:`.Configuration.getvar_s`, :py:meth:`.Configuration.substitute_variables_in_obj` or :py:meth:`.Configuration.expand_variable`