Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Doc]: object description for "spines"of matplot.axes.Axes not found #29964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
mai0503 opened this issue Apr 25, 2025 · 2 comments · Fixed by #29965
Closed

[Doc]: object description for "spines"of matplot.axes.Axes not found #29964

mai0503 opened this issue Apr 25, 2025 · 2 comments · Fixed by #29965
Labels
Documentation
Milestone
v3.10.3

Comments

@mai0503
Copy link

mai0503 commented Apr 25, 2025

Documentation Link

https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#

Problem

I found the documentation of object "spines" of matplot.axes.Axes not clear enough. On the homepage of matplot.axes.Axes there is no link to this description.

Suggested improvement

No response
@rcomer
Copy link
Member

rcomer commented Apr 25, 2025 •
edited
Loading

If it were to link, it would link here: https://matplotlib.org/stable/api/spines_api.html#matplotlib.spines.Spines

axes.spines is an attribute added in instantiation, so I do not think we can hang a docstring off it as-is. Perhaps it should instead be a property?

matplotlib/lib/matplotlib/axes/_base.py

Line 701 in 3d34092

self.spines = mspines.Spines.from_dict(self._gen_axes_spines())

@timhoffm
Copy link
Member

Property oder type annotation works. Both variants are used in https://github.com/matplotlib/matplotlib/pull/28825/files.

@rcomer rcomer mentioned this issue Apr 25, 2025
Merged
5 tasks
@QuLogic QuLogic added this to the v3.10.2 milestone Apr 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.10.3
Development

Successfully merging a pull request may close this issue.

Document Axes.spines rcomer/matplotlib
4 participants
@QuLogic @timhoffm @rcomer @mai0503