summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2013-04-30 18:47:35 +0100
committerLars Wirzenius <liw@liw.fi>2013-04-30 18:47:35 +0100
commit0fde702274b8c51e59561a8c395ac67a5a28653c (patch)
tree9cf4c39047e2df9eb4e8f21591f11f8cfc5c0b36
parent3b1bac289cb330e3fadaa1bbfe0937c5178feb6d (diff)
downloadcliapp-0fde702274b8c51e59561a8c395ac67a5a28653c.tar.gz
Expand the Settings.as_cp method description
-rw-r--r--cliapp/settings.py8
1 files changed, 7 insertions, 1 deletions
diff --git a/cliapp/settings.py b/cliapp/settings.py
index 0c54d84..9fb8a4c 100644
--- a/cliapp/settings.py
+++ b/cliapp/settings.py
@@ -741,7 +741,13 @@ class Settings(object):
sys.exit(0)
def as_cp(self):
- '''Return a ConfigParser instance with current values of settings.'''
+ '''Return a ConfigParser instance with current values of settings.
+
+ Any sections outside of ``[config]`` are preserved as is. This
+ lets the application use those as it wishes, and assign any
+ meanings it desires to the section names.
+
+ '''
cp = ConfigParser.ConfigParser()
cp.add_section('config')
for name in self._canonical_names: