Improve docstrings for data module.

blovering · blovering · commit fa741a9b049b · 2012-04-15T17:40:30.000-07:00
diff --git a/splunklib/data.py b/splunklib/data.py
@@ -57,9 +57,15 @@ def localname(xname):
     return xname if rcurly == -1 else xname[rcurly+1:]
 
 def load(text, match=None):
-    """Load the given XML text into a Python structure, optionally loading 
-       only the matching sub-elements if a match string is given. The match
-       string consists of either a tag name or path."""
+    """Load the given XML text into a native Python structure (dict or list), 
+    optionally loading nly the matching sub-elements if a match string is
+    given. The match string consists of either a tag name or path.
+
+    :param `text`: text (XML) to load
+    :type `text`: string
+    :param `match`: tag name or path (optional)
+    :type `match`: string
+    """
     if text is None: return None
     text = text.strip()
     if len(text) == 0: return None
@@ -165,8 +171,8 @@ def load_value(element, nametable=None):
 
 # A generic utility that enables "dot" access to dicts
 class Record(dict):
-    """A generic utiliity class that enables *dot* access to members of 
-    a Python dict.
+    """A generic utiliity class that enables dot access to members of 
+    a Python dictionary.
     """
     def __call__(self, *args):
         if len(args) == 0: return self
@@ -191,7 +197,11 @@ def fromkv(k, v):
         return result
 
 def record(value=None): 
-    """Returns a record instance constructed using the given value."""
+    """Returns a record instance constructed using the given value.
+    
+    :param `value`: initial record value
+    :type `value`: dict
+    """
     if value is None: value = {}
     return Record(value)
 
