Skip to content

Commit 45f7d5d

Browse files
committed
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 matplotlib#12467
1 parent 747c2a7 commit 45f7d5d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

lib/matplotlib/offsetbox.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1235,8 +1235,9 @@ def __init__(self, s, loc, pad=0.4, borderpad=0.5, prop=None, **kwargs):
12351235
borderpad : float, optional
12361236
Pad between the frame and the axes (or *bbox_to_anchor*).
12371237
1238-
prop : `matplotlib.font_manager.FontProperties`
1239-
Font properties.
1238+
prop : dictionary, optional, default: None
1239+
Dictionary of keyword parameters to be passed to the
1240+
`~matplotlib.text.Text` instance contained inside AnchoredText.
12401241
12411242
Notes
12421243
-----

0 commit comments

Comments
 (0)