Capitalize headings in example Gallery#25017
Conversation
|
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 etc, but not sure exactly what that would look like. |
|
It is not clear what a "top-level chapter" is in but looking the current documentation it seems like there are no top-level chapters... |
|
I've now changed it to Regarding module names: I think the style guide saies that "`" should not be used. |
|
Please don't change the capitalization or remove underscores from module names (you can't |
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? I think module names should only be used in the reference headings:
Yes, but so one can not do |
Indeed, but pyplot is nothing but a module name, whereas Statistics is obviously a common noun. |
|
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. |
|
Thanks for these very quick responses!
For consistency, I've now changed it to |
…017-on-v3.7.x Backport PR #25017 on branch v3.7.x (Capitalize headings in example Gallery)

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

This pr capitalizes all headings.