Document Axes.spines #29965
Merged
Document Axes.spines #29965
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
jklymak
reviewed
Apr 25, 2025
Comment on lines
+563
to
+564
| The `.Spines` container for the Axes' spines, i.e. the lines denoting the | ||
| data area boundaries. |
There was a problem hiding this comment.
Maybe:
Suggested change
| The `.Spines` container for the Axes' spines, i.e. the lines denoting the | |
| data area boundaries. | |
| The `.Spines` container for the Axes' spines, usually the lines that denote the x- and y-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.
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.
FWIW, I got "data area boundaries" from here https://matplotlib.org/stable/api/spines_api.html#matplotlib.spines.Spine
There was a problem hiding this comment.
Fair enough because some of the spines do not have axis info on them. I still found it an odd construction.
jklymak
approved these changes
Apr 25, 2025
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Apr 25, 2025
QuLogic
added a commit
that referenced
this pull request
Apr 26, 2025
…965-on-v3.10.x Backport PR #29965 on branch v3.10.x (Document Axes.spines)
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.
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