You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Documentation of TextArea's fontprops keyword argument is misleading #12121
The documentation for TextArea strongly suggests that the keyword argument fontprops should be a FontProperties object. However, inspecting the source code suggests that fontprops should instead be a dictionary of keyword arguments that will be passed to the Text object inside TextArea.
I propose rewording the documentation to make it clear that fontprops should be a dictionary of keyword arguments.
Actually, 1. is the way to go. The argument is correctly called textprops and passed as Text(..., **textprops). Thus FontProperties is just plain wrong.
Activity
ImportanceOfBeingErnest commentedon Oct 7, 2018
There are two options:
FontPropertiesobjects as input. Then update the documentation.@galenlynch Any interest in making that change an submitting a pull request?
timhoffm commentedon Oct 7, 2018
Actually, 1. is the way to go. The argument is correctly called
textpropsand passed asText(..., **textprops). ThusFontPropertiesis just plain wrong.galenlynch commentedon Oct 7, 2018
Sure, glad to make a PR with option 1.
Clarify documentation for textprops keyword parameter of TextArea
Clarify documentation for textprops keyword parameter of TextArea