Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Capitalize headings in example Gallery#25017

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

Merged
QuLogic merged 3 commits intomatplotlib:mainfromkolibril13:patch1
Jan 19, 2023

Conversation

kolibril13
Copy link
Contributor

The headings in the example section are mostly upper case, but also a few lowercase headings::
image

This pr capitalizes all headings.

@oscargus
Copy link
Member

Thanks you for this PR! However, as those that you modified here are module names, I am not sure that they should be modified, at least not like this.

(Also, I think the style guide indicates that "Title Case" should not be used.https://matplotlib.org/stable/devel/documenting_mpl.html#formatting-and-style-conventions Rather "Specialty Plots" should probably be changed to "Specialty plots".)

I do agree with you though that the current approach looks a bit weird. Maybe one should format the modules as "code", so

``pyplot``=======

etc, but not sure exactly what that would look like.

rcomer reacted with thumbs up emoji

@oscargus
Copy link
Member

It is not clear what a "top-level chapter" is in

For everything but top-level chapters

but looking the current documentation it seems like there are no top-level chapters...

@kolibril13
Copy link
ContributorAuthor

I've now changed it toUpper lower.
For most example names in the gallery, there is theTitle Case used.
image

Regarding module names: I think the style guide saies that "`" should not be used.
https://matplotlib.org/stable/devel/documenting_mpl.html#function-arguments

@anntzer
Copy link
Contributor

Please don't change the capitalization or remove underscores from module names (you can'timport Pyplot orimport Axes grid). If you want to make these more homogeneous, I would write e.g.The pyplot module/The axes_grid1 module.

@kolibril13
Copy link
ContributorAuthor

kolibril13 commentedJan 18, 2023
edited
Loading

Please don't change the capitalization or remove underscores from module names

My changes are affecting the example gallery, so I thought that the example gallery captions should have names that describe to the users what examples to expect. Are the example gallery captions the right place for module names?
In my opinion no, but I am open to be convinced otherwise.

I think module names should only be used in the reference headings:
https://matplotlib.org/stable/api/toolkits/axes_grid1.html#mpl-toolkits-axes-grid1

you can'timport Pyplot orimport Axes grid

Yes, but so one can not doimport Statistics from theStatistics section

@anntzer
Copy link
Contributor

anntzer commentedJan 18, 2023
edited
Loading

Yes, but so one can not do import Statistics from the Statistics section

Indeed, but pyplot is nothingbut a module name, whereas Statistics is obviously a common noun.
Anyways, I've made my point, I don't like the change here but other reviewers can disagree.

jklymak and kolibril13 reacted with thumbs up emoji

@oscargus
Copy link
Member

Just to confirm that what@anntzer maybe expressed clearer, is exactly what I was trying to say with the example. These are modules and should be spelled as the module, probably with some formatting to make it clear that it is a module.

jklymak and kolibril13 reacted with thumbs up emoji

Copy link
Member

@jklymakjklymak left a comment

Choose a reason for hiding this comment

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

Thanks for this, but I agree with@oscargus and@anntzer: the last one is fine, the rest are incorrect.

@kolibril13
Copy link
ContributorAuthor

Thanks for these very quick responses!

probably with some formatting to make it clear that it is a module

For consistency, I've now changed it toThe axes_grid1 module ,The axisartist module andThe pyplot module

@QuLogicQuLogic added this to thev3.7.0 milestoneJan 19, 2023
@QuLogicQuLogic merged commite12b75d intomatplotlib:mainJan 19, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestJan 19, 2023
oscargus added a commit that referenced this pull requestJan 19, 2023
…017-on-v3.7.xBackport PR#25017 on branch v3.7.x (Capitalize headings in example Gallery)
@ksundenksunden mentioned this pull requestFeb 20, 2023
6 tasks
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@jklymakjklymakjklymak approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.7.0
Development

Successfully merging this pull request may close these issues.

5 participants
@kolibril13@oscargus@anntzer@jklymak@QuLogic

[8]ページ先頭

©2009-2025 Movatter.jp