Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 2aa52db

Browse filesBrowse files
galenlynchgalenlynch
committed
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
1 parent 1c17868 commit 2aa52db
Copy full SHA for 2aa52db

File tree

Expand file treeCollapse file tree

1 file changed

+3
-1
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+3
-1
lines changed

‎lib/matplotlib/offsetbox.py

Copy file name to clipboardExpand all lines: lib/matplotlib/offsetbox.py
+3-1Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -701,7 +701,9 @@ def __init__(self, s,
701701
s : str
702702
a string to be displayed.
703703
704-
textprops : `~matplotlib.font_manager.FontProperties`, optional
704+
textprops : dictionary, optional, default: None
705+
Dictionary of keyword parameters to be passed to the
706+
`~matplotlib.text.Text` instance contained inside TextArea.
705707
706708
multilinebaseline : bool, optional
707709
If `True`, baseline for multiline text is adjusted so that

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.