From: Christian Herdtweck <christian.herdtweck@intra2net.com>
Date: Mon, 2 Dec 2019 12:12:34 +0000 (+0100)
Subject: Minor improvement of comments for SimpleCnf
X-Git-Tag: v1.6.4~4
X-Git-Url: http://developer.intra2net.com/git/?p=pyi2ncommon;a=commitdiff_plain;h=6ac093dfeb24bd3e32ccd66c3c4ae0448c006e87

Minor improvement of comments for SimpleCnf
---

diff --git a/src/simple_cnf.py b/src/simple_cnf.py
index 9d9958d..bd43ccb 100644
--- a/src/simple_cnf.py
+++ b/src/simple_cnf.py
@@ -229,13 +229,17 @@ class SimpleCnf(object):
 
     Based on C++ `cnf_vars` as visualized by *get_cnf*.
 
-    Internal data representation: see module doc
+    Internal data representation: list of conf var dicts; see module doc for
+    details
     """
 
     def __init__(self, cnf=None):
         """
         Creates a simple configuration.
 
+        Does not check whether given cnf list contains only valid data.
+        Does not recurse into dicts.
+
         :param cnf: initial set of conf var data (default: None = empty conf)
         :type cnf: list or anything that :py:func:`get_cnf` can read
         """