From 45f7d5d2dbeabaa4a90169f9acc976b6ca53ced1 Mon Sep 17 00:00:00 2001 From: Galen Lynch Date: Tue, 9 Oct 2018 17:03:05 -0400 Subject: [PATCH] Clarify documentation of offsetbox.AnchoredText's prop kw argument `prop` should be a dictionary of keyword arguments that will be passed to the `Text` object contained in `AnchoredText` (via `TextArea`). The current documentation suggests that it should instead be a `FontProperties` object. This commit changes the documentation to reflect the current behavior. closes #12467 --- lib/matplotlib/offsetbox.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py index 479c824a50f7..65208fe39b6a 100644 --- a/lib/matplotlib/offsetbox.py +++ b/lib/matplotlib/offsetbox.py @@ -1235,8 +1235,9 @@ def __init__(self, s, loc, pad=0.4, borderpad=0.5, prop=None, **kwargs): borderpad : float, optional Pad between the frame and the axes (or *bbox_to_anchor*). - prop : `matplotlib.font_manager.FontProperties` - Font properties. + prop : dictionary, optional, default: None + Dictionary of keyword parameters to be passed to the + `~matplotlib.text.Text` instance contained inside AnchoredText. Notes -----