Skip to content

Clarify documentation for textprops keyword parameter of TextArea #12434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 7, 2018
Merged

Clarify documentation for textprops keyword parameter of TextArea #12434

merged 1 commit into from
Oct 7, 2018

Conversation

galenlynch
Copy link
Contributor

@galenlynch galenlynch commented Oct 7, 2018 •
edited
Loading

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

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@galenlynch
Clarify documentation for textprops keyword parameter of TextArea
2aa52db 
As described in matplotlib#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 matplotlib#12121
@galenlynch galenlynch force-pushed the clarify_TextArea_fontprops_documentation branch from f0b549c to 2aa52db Compare October 7, 2018 18:39
@anntzer anntzer merged commit 9cffe0e into matplotlib:master Oct 7, 2018
@anntzer
Copy link
Contributor

anntzer commented Oct 7, 2018

thanks!

@QuLogic QuLogic added this to the v3.1 milestone Oct 7, 2018
@galenlynch galenlynch deleted the clarify_TextArea_fontprops_documentation branch October 7, 2018 20:15
@galenlynch
Copy link
Contributor Author

My pleasure!

@ImportanceOfBeingErnest ImportanceOfBeingErnest mentioned this pull request Oct 9, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.1.0
Development

Successfully merging this pull request may close these issues.

Documentation of TextArea's fontprops keyword argument is misleading
4 participants
@galenlynch @anntzer @timhoffm @QuLogic