Clarify documentation of offsetbox.AnchoredText's prop kw argument #12469
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`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
timhoffm
approved these changes
Oct 10, 2018
ImportanceOfBeingErnest
approved these changes
Oct 10, 2018
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Oct 10, 2018
…oredText's prop kw argument
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Oct 10, 2018
…oredText's prop kw argument
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
propshould be a dictionary of keyword arguments that will be passed to theTextobject contained inAnchoredText(viaTextArea). The currentdocumentation suggests that it should instead be a
FontPropertiesobject.This commit changes the documentation to reflect the current behavior.
closes #12467
PR Summary
PR Checklist