Deprecate positional passing of most Artist constructor parameters #23177
Conversation
0c6af5b to
f6047ea
Compare
f6047ea to
1958b10
Compare
| @@ -498,6 +498,8 @@ class PaddedBox(OffsetBox): | |||
| The `.PaddedBox` contains a `.FancyBboxPatch` that is used to visualize | |||
| it when rendering. | |||
| """ | |||
|
|
|||
| @_api.make_keyword_only("3.6", name="draw_frame") | |||
There was a problem hiding this comment.
Do you want to start at "pad" here? In AnchoredText/AnchoredBox you chose "pad".
There was a problem hiding this comment.
I'd leave this as proposed. If in doubt I try to err on the more permissive side, so that we don't overly constrain the API and force people to change still reasonable calls. For PaddedBox pad is quite canonical and I think we should still allow PaddedBox(child, 0.5). AnchoredText/AnchoredBox have other parameters before pad and pad as central a concept as it is with PaddedBox.
lib/matplotlib/patches.py
Outdated
| @@ -3916,6 +3927,7 @@ def __str__(self): | |||
| return s % (self._x, self._y, self._width, self._height) | |||
|
|
|||
| @_docstring.dedent_interpd | |||
| @_api.make_keyword_only("3.6", name="bbox_transmuter") | |||
There was a problem hiding this comment.
Probably start this at boxstyle since bbox_transmuter is deprecated (you could remove that here even?).
There was a problem hiding this comment.
Started one later with mutation_scale. Same argument with erring on the permissive side `FancyBboxPatch((0, 0), 5, 8, "round") is still sort of reasonable.
This should have very little impact on the practical use, as it's anyway error-prone to pass more than a few arguments by position. But enforcing keyword-only makes future API changes simpler for us.
1958b10 to
aee51c8
Compare
|
@greglucas is OK with current state as discussed on the call. |
Follow up to and generalization of #23166.
This should have very little impact on the practical use, as it's anyway
error-prone to pass more than a few arguments by position. But enforcing
keyword-only makes future API changes simpler for us.