Skip to content

Clarify documentation of offsetbox.AnchoredText's prop kw argument - #12469

Merged
ImportanceOfBeingErnest merged 1 commit into
matplotlib:masterfrom
galenlynch:fix_AnchoredText_props_kw_doc
Oct 10, 2018
Merged

ImportanceOfBeingErnest merged 1 commit into
matplotlib:masterfrom
galenlynch:fix_AnchoredText_props_kw_doc

Conversation

@galenlynch

Copy link
Copy Markdown
Contributor

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

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

`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
@ImportanceOfBeingErnest
ImportanceOfBeingErnest merged commit f77c979 into matplotlib:master Oct 10, 2018
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Oct 10, 2018
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Oct 10, 2018
jklymak added a commit that referenced this pull request Oct 10, 2018
…469-on-v3.0.0-doc

Backport PR #12469 on branch v3.0.0-doc (Clarify documentation of offsetbox.AnchoredText's prop kw argument)
jklymak added a commit that referenced this pull request Oct 10, 2018
…469-on-v3.0.x

Backport PR #12469 on branch v3.0.x (Clarify documentation of offsetbox.AnchoredText's prop kw argument)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation of AnchoredText's prop keyword argument is misleading

3 participants