Mercurial > hgrepos > Python > libs > ConfigMix
changeset 343:c8b98285a7b5
docs: some more docu for tree references
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Mon, 10 May 2021 09:17:12 +0200 |
| parents | dde6dea50ea3 |
| children | ce7aea9eac4a |
| files | docs/introduction.rst |
| diffstat | 1 files changed, 12 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/introduction.rst Mon May 10 09:16:04 2021 +0200 +++ b/docs/introduction.rst Mon May 10 09:17:12 2021 +0200 @@ -451,14 +451,20 @@ With ``{{ref:#my.other.key}}`` -- special namespace ``ref`` +- think of it as a sort of a symbolic link to other parts of the + configuration tree +- by employing the special namespace ``ref`` - can not be quoted currently in variable interpolation syntax -- No special handling when merging is done -- Keys within :meth:`.Configuration.getvar_s()` and - :py:meth:`.Configuration.getvar()` are handled -- in :py:meth:`.Configuration.getvar()` only, when it is the directly +- No special handling when merging is done -- merging is agnostic of + tree references +- Keys within :meth:`.Configuration.getvar_s`, + :py:meth:`.Configuration.getvar`, :py:meth:`.Configuration.getvarl` + and :py:meth:`.Configuration.getvarl_s` are handled +- in :py:meth:`.Configuration.getvar` only, when it is the directly referenced value -- recursive expandion in :py:meth:`.Configuration.getvar_s()` expands +- recursive expansion in :py:meth:`.Configuration.getvar_s` and + :py:meth:`.Configuration.getvarl_s`: + beware of recursive (direct or indirect) tree references .. _quoting: