Mercurial > hgrepos > Python > libs > ConfigMix

changeset 388:13427f37abab

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: document Configuration.getfirstvarl_s()
author Franz Glasner <fzglas.hg@dom66.de>
date Wed, 10 Nov 2021 02:43:23 +0100
parents b2c0550d5a44
children 44ef854da70a
files configmix/config.py
diffstat 1 files changed, 11 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- 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)):