diff configmix/config.py @ 397:88239f28415c

Docs
author Franz Glasner <fzglas.hg@dom66.de>
date Thu, 18 Nov 2021 22:29:05 +0100
parents a50f8fb16b05
children b1f82b853290
line wrap: on
line diff
--- a/configmix/config.py	Thu Nov 18 22:14:34 2021 +0100
+++ b/configmix/config.py	Thu Nov 18 22:29:05 2021 +0100
@@ -654,6 +654,9 @@
     def jailed(self, rootpath=None, root=None):
         """Return a "jailed" configuration.
 
+        :return: a jailed (aka restricted) configuration
+        :rtype: _JailedConfiguration
+
         """
         if rootpath is not None and root is not None:
             raise ValueError("only one of `rootpath' or `root' can be given")
@@ -675,7 +678,11 @@
 
 class _JailedConfiguration(object):
 
-    """Chrooted into a subtree of the configuration  -- no namespace support"""
+    """A jailed and restricted variant of :class:`Configuration`.
+
+    No namespace support.
+
+    """
 
     __slots__ = ("_base", "_path", "_pathstr")