Clarify documentation for textprops keyword parameter of TextArea

galenlynch · galenlynch · commit f0b549cc4b40 · 2018-10-07T14:28:34.000-04:00
As described in #12121, the current documentation of `textprops` keyword parameter strongly, and erroneously, suggests that `textprops` should be a FontProperties object. In reality, it should instead be a dictionary of keyword parameters that will be passed to the `Text` object inside of `TextArea`. This commit changes the documentation to reflect the current behavior. closes #12121
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -701,8 +701,9 @@ def __init__(self, s,
         s : str
             a string to be displayed.
 
-        textprops : `~matplotlib.font_manager.FontProperties`, optional
-
+        textprops : dictionary, optional, default: None
+            Dictionary of keyword parameters to be passed to the
+            `~matplotlib.text.Text` instance contained inside TextArea.
         multilinebaseline : bool, optional
             If `True`, baseline for multiline text is adjusted so that
             it is (approximatedly) center-aligned with singleline
