Docstring addition

Mrngilles · Mrngilles · commit 2e10ffc2d7b4 · 2015-07-20T00:20:37.000+02:00
diff --git a/lib/matplotlib/style/core.py b/lib/matplotlib/style/core.py
@@ -64,7 +64,7 @@ def use(styles):
     """
     if cbook.is_string_like(styles):
        styles = [styles]
-    flattened_style = flatten_style_dict({PARENT_STYLES: styles})
+    flattened_style = _flatten_style_dict({PARENT_STYLES: styles})
     mpl.rcParams.update(flattened_style)
 
 
@@ -119,12 +119,20 @@ def flatten_inheritance_dict(child_dict, parent_key,
     return output_dict
 
 
-def flatten_style_dict(style_dict):
+def _flatten_style_dict(style_dict):
     return flatten_inheritance_dict(style_dict, PARENT_STYLES, expand_parent=_expand_parent)
 
 
 def get_style_dict(style):
-    """Get the parameter rc of the style file"""
+    """Returns a dictionnary containing all the parameters from the
+    style file.
+
+    Parameters
+    ----------
+    style : str
+        style from the default library, the personal library or any
+        full path.
+    """
     if style in library:
         return library[style]
     else:
