changeset 18:a04fa81e10ae

Doc
author Franz Glasner <f.glasner@feldmann-mg.com>
date Thu, 10 Mar 2016 10:45:09 +0100
parents 94b5e94fae44
children 04505a8dbfc0
files configmix/config.py
diffstat 1 files changed, 8 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/configmix/config.py	Thu Mar 10 10:42:55 2016 +0100
+++ b/configmix/config.py	Thu Mar 10 10:45:09 2016 +0100
@@ -41,6 +41,14 @@
 
 class Configuration(_AttributeDict):
 
+    """The configuration dictionary with attribute support or
+    variable substitution.
+
+    .. note:: When retriving by attribute names variables will *not*
+              substituted.
+
+    """
+
     def getvar(self, varname, default=_MARKER):
         """Get a variable of the form ``[[ns1.]ns2.]name`` - including
         variables from other namespaces.