MNT/DOC: Deprecate anchor in Axes3D.set_aspect #30408
Conversation
4e0dfa6 to
5088f5d
Compare
5088f5d to
8f0e5ec
Compare
|
Hello |
| @@ -244,7 +244,7 @@ def _transformed_cube(self, vals): | |||
| (minx, maxy, maxz)] | |||
| return proj3d._proj_points(xyzs, self.M) | |||
|
|
|||
| def set_aspect(self, aspect, adjustable=None, anchor=None, share=False): | |||
| def set_aspect(self, aspect, adjustable=None, anchor=None): | |||
There was a problem hiding this comment.
Hello! I removed the share parameter because it was only being passed to the super().set_aspect() call.
During local testing, I found that the super() call was causing an ImageComparisonFailure in the existing test_aspects test. Based on the original issue's suggestion and that test failure, I removed the super() call entirely. Since share was no longer being used anywhere inside the method, I removed it from the signature and docstring as well to clean up the unused code.
Please let me know if you think it should be handled differently
| 'SE' lower right corner | ||
| etc. | ||
| ===== ===================== | ||
| ``adjustable`` : None or {'box', 'datalim'}, optional |
| This parameter is not used for 3D axes but is present for | ||
| compatibility with 2D axes. It will be ignored. |
There was a problem hiding this comment.
This doesn't seem to be what the title of the PR / the related issue suggests; is it true?
|
|
||
| share : bool, default: False | ||
| If ``True``, apply the settings to all shared Axes. | ||
| ``anchor`` : None or str or 2-tuple of float, optional |
There was a problem hiding this comment.
Why is this changed to code style?
There was a problem hiding this comment.
This should go in one of the existing files unless you definitely don't see one that matches, but it shouldn't have this name then.
| If ``True``, apply the settings to all shared Axes. | ||
| ``anchor`` : None or str or 2-tuple of float, optional | ||
| .. deprecated:: 3.11 | ||
| The `anchor` parameter is not used for 3D axes and will be |
There was a problem hiding this comment.
You can't reference parameters.
| The `anchor` parameter is not used for 3D axes and will be | |
| The *anchor* parameter is not used for 3D axes and will be |
This PR closes #30364 .
PR summary
This PR cleans up the
Axes3D.set_aspectmethod by deprecating the unusedanchorparameter and clarifying the documentation for 3D-specific behavior.Why is this change necessary? The method inherited the
anchorandadjustableparameters from its 2D parent, but these are confusing and not applicable in a 3D context. This led to an inaccurate docstring.What problem does it solve? It removes a confusing, non-functional parameter from the API and provides users with clear, accurate documentation for how
set_aspectbehaves on 3D axes.What is the reasoning for this implementation?
anchoris used, making the deprecation clear to users without breaking existing tests that rely on the defaultanchor=None.super()call has been removed to simplify the logic, resolving a visual inconsistency found during testing.adjustableparameter and formally deprecateanchor.A new unit test has been added to specifically verify the deprecation warning is raised correctly.
PR checklist
anchorandadjustablearguments #30364 " is in the body of the PR description to link the related issue