Merge pull request #3954 from jenshnielsen/accepts_issue

tacaswell · tacaswell · commit a1fdaedc4c4e · 2014-12-28T14:30:13.000-08:00
DOC : Simplify set_boxstyle Accepts section of FancyBboxPatch
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -1733,6 +1733,18 @@ def _pprint_styles(_styles):
     return _pprint_table(_table)
 
 
+def _simpleprint_styles(_styles):
+    """
+    A helper function for the _Style class.  Given the dictionary of
+    (stylename : styleclass), return a string rep of the list of keys.
+    Used to update the documentation.
+    """
+    styles = "[ \'"
+    styles += "\' | \'".join(str(i) for i in sorted(_styles.keys()))
+    styles += "\' ]"
+    return styles
+
+
 class _Style(object):
     """
     A base class for the Styles. It is meant to be a container class,
@@ -2313,7 +2325,8 @@ def transmute(self, x0, y0, width, height, mutation_size):
                {"AvailableBoxstyles": _pprint_styles(_style_list)}
 
 docstring.interpd.update(
-    AvailableBoxstyles=_pprint_styles(BoxStyle._style_list))
+    AvailableBoxstyles=_pprint_styles(BoxStyle._style_list),
+    ListBoxstyles=_simpleprint_styles(BoxStyle._style_list))
 
 
 class FancyBboxPatch(Patch):
@@ -2398,7 +2411,10 @@ def set_boxstyle(self, boxstyle=None, **kw):
         Without argument (or with *boxstyle* = None), it returns
         available box styles.
 
-        ACCEPTS: %(AvailableBoxstyles)s
+        The following boxstyles are available:
+        %(AvailableBoxstyles)s
+
+        ACCEPTS: %(ListBoxstyles)s
 
         """
         if boxstyle is None:
