comparison docs/introduction.rst @ 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 ae4b76d0da45
children d7daec119383
comparison
equal deleted inserted replaced
342:dde6dea50ea3 343:c8b98285a7b5
449 Configuration tree references 449 Configuration tree references
450 ----------------------------- 450 -----------------------------
451 451
452 With ``{{ref:#my.other.key}}`` 452 With ``{{ref:#my.other.key}}``
453 453
454 - special namespace ``ref`` 454 - think of it as a sort of a symbolic link to other parts of the
455 configuration tree
456 - by employing the special namespace ``ref``
455 - can not be quoted currently in variable interpolation syntax 457 - can not be quoted currently in variable interpolation syntax
456 - No special handling when merging is done 458 - No special handling when merging is done -- merging is agnostic of
457 - Keys within :meth:`.Configuration.getvar_s()` and 459 tree references
458 :py:meth:`.Configuration.getvar()` are handled 460 - Keys within :meth:`.Configuration.getvar_s`,
459 - in :py:meth:`.Configuration.getvar()` only, when it is the directly 461 :py:meth:`.Configuration.getvar`, :py:meth:`.Configuration.getvarl`
462 and :py:meth:`.Configuration.getvarl_s` are handled
463 - in :py:meth:`.Configuration.getvar` only, when it is the directly
460 referenced value 464 referenced value
461 - recursive expandion in :py:meth:`.Configuration.getvar_s()` expands 465 - recursive expansion in :py:meth:`.Configuration.getvar_s` and
466 :py:meth:`.Configuration.getvarl_s`:
467 beware of recursive (direct or indirect) tree references
462 468
463 469
464 .. _quoting: 470 .. _quoting:
465 471
466 Quoting 472 Quoting