Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Document Axes.spines#29965
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Document Axes.spines#29965
Uh oh!
There was an error while loading.Please reload this page.
Conversation
| The `.Spines` container for the Axes' spines, i.e. the lines denoting the | ||
| data area boundaries. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Maybe:
| The`.Spines`containerfortheAxes'spines,i.e.thelinesdenotingthe | |
| dataareaboundaries. | |
| The`.Spines`containerfortheAxes'spines,usuallythelinesthatdenotethex-andy-axis. |
because the spines need not be on the data area boundaries (of course they need not be x or y axises either, but "usually" should be fine for that)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I slightly lean towards the present description. While not general, it's what the default is, and thus it's easier to understand. Possibly a more detailed description should go into the class docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
FWIW, I got "data area boundaries" from herehttps://matplotlib.org/stable/api/spines_api.html#matplotlib.spines.Spine
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Fair enough because some of the spines do not have axis info on them. I still found it an odd construction.
4af11e7 intomatplotlib:mainUh oh!
There was an error while loading.Please reload this page.
…965-on-v3.10.xBackport PR#29965 on branch v3.10.x (Document Axes.spines)
PR summary
Closes#29964, by hanging a docstring from a class level type hint. I did not know you could do this - so thanks to@timhoffm for the pointer.
PR checklist