# HG changeset patch # User Franz Glasner # Date 1636508603 -3600 # Node ID 13427f37ababc4a3da759decf2f3f3d6e27b2a0e # Parent b2c0550d5a44a7feef960b794867e71832ee7d6d Docs: document Configuration.getfirstvarl_s() diff -r b2c0550d5a44 -r 13427f37abab configmix/config.py --- a/configmix/config.py Wed Nov 10 02:38:38 2021 +0100 +++ b/configmix/config.py Wed Nov 10 02:43:23 2021 +0100 @@ -208,6 +208,17 @@ return default def getfirstvarl_s(self, *paths, **kwds): + """A variant of :meth:`~.getfirstvarl` that does variable + interpolation. + + `paths` and `kwds` are interpreted as in :meth:`.getfirstvarl`. + But variables will be interpolated + recursively within the variable values and filters are + applied. + + For more details see chapter :ref:`variable-interpolation`. + + """ default = kwds.pop("default", _MARKER) for path in paths: if isinstance(path, (list, tuple)):