Skip to content

Use Axes instead of axes in galleries#27104

Merged
timhoffm merged 1 commit into
matplotlib:mainfrom
timhoffm:doc-axes
Dec 22, 2023
Merged

Use Axes instead of axes in galleries#27104
timhoffm merged 1 commit into
matplotlib:mainfrom
timhoffm:doc-axes

Conversation

@timhoffm

Copy link
Copy Markdown
Member

Part of #18726.

On a side-note: What I have learned from this: Even when knowing the definitions and differences between Axes and axes as a simple plural of axis, it is quite challenging to sort out which one to use in a couple of places. I have now a vague impression how confusing that naming may be to our users.

@story645 story645 added the Documentation: examples files in galleries/examples label Oct 16, 2023
@story645

story645 commented Oct 16, 2023

Copy link
Copy Markdown
Member

and axes as a simple plural of axis,

If we still do this anywhere, we should probably change it to x and y (and/or whatever else) axis to save everyone some trouble.

@timhoffm timhoffm added this to the v3.9.0 milestone Oct 16, 2023
@timhoffm

timhoffm commented Oct 16, 2023

Copy link
Copy Markdown
Member Author

If we still do this anywhere, we should probably change it to x and y (and/or whatever else) axis to save everyone some trouble.

Possibly in some places, though that's not practical everywhere. There are edge cases like axes coordinates that I have not touched and others cases where additional qualification is not needed or rather distracting when the context is clear. One could grep through the remaining "axes", but overall I think that's a second-order improvement. Consistently using Axes where it clearly denotes the object and is not a multiple of axis (=this PR) is the main improvement to reduce confusion.

@timhoffm timhoffm added Documentation and removed Documentation: examples files in galleries/examples labels Oct 16, 2023

@ksunden ksunden left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to #27105, a couple notes here and there, but largely agree.

I so still have the figure or Axes feels incongruent when in close proximity and exactly one of them is capitalized, though that seemed less common as I read through this set of files.

Comment thread galleries/examples/spines/spines_dropped.py Outdated
Comment thread galleries/tutorials/pyplot.py Outdated
Comment thread lib/matplotlib/figure.py
@timhoffm timhoffm merged commit e5a85f9 into matplotlib:main Dec 22, 2023
@timhoffm timhoffm deleted the doc-axes branch December 22, 2023 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants