comment config
authorEmmanuel Garette <egarette@cadoles.com>
Mon, 23 Sep 2013 20:55:54 +0000 (22:55 +0200)
committerEmmanuel Garette <egarette@cadoles.com>
Mon, 23 Sep 2013 20:55:54 +0000 (22:55 +0200)
tiramisu/config.py

index f1b2851..3687349 100644 (file)
@@ -1,5 +1,4 @@
 # -*- coding: utf-8 -*-
-"options handler global entry point"
 # Copyright (C) 2012-2013 Team tiramisu (see AUTHORS for all contributors)
 #
 # This program is free software; you can redistribute it and/or modify
@@ -20,6 +19,7 @@
 # the rough pypy's guys: http://codespeak.net/svn/pypy/dist/pypy/config/
 # the whole pypy projet is under MIT licence
 # ____________________________________________________________
+"options handler global entry point"
 import weakref
 from tiramisu.error import PropertiesOptionError, ConfigError
 from tiramisu.option import OptionDescription, Option, SymLinkOption
@@ -31,7 +31,11 @@ from tiramisu.i18n import _
 
 
 class SubConfig(object):
-    "sub configuration management entry"
+    """Sub configuration management entry.
+    Tree if OptionDescription's responsability. SubConfig are generated
+    on-demand. A Config is also a SubConfig.
+    Root Config is call context below
+    """
     __slots__ = ('_impl_context', '_impl_descr', '_impl_path')
 
     def __init__(self, descr, context, subpath=None):
@@ -56,6 +60,7 @@ class SubConfig(object):
 
     def cfgimpl_reset_cache(self, only_expired=False, only=('values',
                                                             'settings')):
+        "remove cache (in context)"
         self._cfgimpl_get_context().cfgimpl_reset_cache(only_expired, only)
 
     def cfgimpl_get_home_by_path(self, path, force_permissive=False,