From 2aa52dbd990794af0a87539f9d508a4ce08b4fce Mon Sep 17 00:00:00 2001 From: Galen Lynch Date: Sun, 7 Oct 2018 14:28:34 -0400 Subject: [PATCH] Clarify documentation for textprops keyword parameter of TextArea 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 --- lib/matplotlib/offsetbox.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py index b85d9994eb66..479c824a50f7 100644 --- a/lib/matplotlib/offsetbox.py +++ b/lib/matplotlib/offsetbox.py @@ -701,7 +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