Deprecate FancyBboxPatch(..., boxstyle="custom", bbox_transmuter=...)
#17749
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
|
The docs for |
b44be42 to
0c907b6
Compare
|
I copied the docstring from the constructor. Technically the docstring is wrong because |
QuLogic
approved these changes
Jun 25, 2020
0c907b6 to
9a1cf9a
Compare
timhoffm
reviewed
Jun 26, 2020
|
Do we need to document that you can pass an arbitrary callable with the right signature? |
|
We do, but the situation is currently the same for arrow/connectionstyle, and we also have the |
One can directly pass the custom bbox as the `boxstyle` argument, instead of setting `boxstyle` to "custom" and passing it as the (otherwise unused) `bbox_transmuter` argument. This is consistent with arrowstyles and connectionstyles. The old API appears to date back to very early boxstyle API designs (pre-73f34bf), where arbitrary callables were not directly supported. In text.py one can just not pop `bbox_transmuter` from rectprops but just pass the dict as is to FancyBboxPatch, triggering the deprecation if and only if the key is present.
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
f69fdeb to
d50234c
Compare
tacaswell
approved these changes
Jun 28, 2020
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.
One can directly pass the custom bbox as the
boxstyleargument,instead of setting
boxstyleto "custom" and passing it as the(otherwise unused)
bbox_transmuterargument. This is consistent witharrowstyles and connectionstyles.
The old API appears to date back to very early boxstyle API designs
(pre-73f34bf), where arbitrary callables were not directly supported.
In text.py one can just not pop
bbox_transmuterfrom rectprops butjust pass the dict as is to FancyBboxPatch, triggering the deprecation
if and only if the key is present.
PR Summary
PR Checklist