8000 Fixing Sentence Case on Section Titles in users_explain by mattymo30 · Pull Request #27325 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Fixing Sentence Case on Section Titles in users_explain #27325

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 13 commits into from
Dec 2, 2023
Merged

Fixing Sentence Case on Section Titles in users_explain #27325

merged 13 commits into from
Dec 2, 2023

Conversation

mattymo30
Copy link
Contributor

PR summary

In Matplotlib's documentation, it states that sections should follow sentence case for section titles. However, I noticed the usage of sentence case was inconsistent between all of the users_explain sections. This PR went through all the sections and fixed the sections to follow sentence casing for titles.

PR checklist

@oscargus oscargus added the Documentation: user guide files in galleries/users_explain or doc/users label Nov 15, 2023
@oscargus
Copy link
Member

Thanks for this! However, it seems like there are merge conflicts. Probably because parts of this was changed recently and your PR is not based on the very latest version.

@mattymo30
Copy link
Contributor Author

Thanks for this! However, it seems like there are merge conflicts. Probably because parts of this was changed recently and your PR is not based on the very latest version.

Sorry about that. The merge conflicts should be resolved

melissawm
melissawm approved these changes Nov 17, 2023
View reviewed changes
Copy link
Member
@melissawm melissawm left a comment

Choose a reason for hiding this comment

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

These look fine to me, let's wait for a maintainer to review. Thanks!

@story645
Copy link
Member

Um to make things very confusing, we use Title case for titles, sentence case for sections so the title changes here should be put back https://matplotlib.org/devdocs/devel/document.html#section-formatting

story645
story645 reviewed Nov 17, 2023
View reviewed changes
Copy link
Member
@story645 story645 left a comment

Choose a reason for hiding this comment

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

Started changing things and then realized I'm not sure if @jklymak intended these pages as sections or titles.

@jklymak
Copy link
Member
jklymak commented Nov 17, 2023

I didn't do any formatting for this reorganization. I suspect that these should all be sentence case except when it is a class name being discussed.

mattymo30 and others added 6 commits November 20, 2023 13:43
@mattymo30 @story645
Update galleries/users_explain/artists/paths.py
60ecb12 
Co-authored-by: hannah <story645@gmail.com>
@mattymo30 @story645
Update galleries/users_explain/artists/transforms_tutorial.py
e9f5e75 
Co-authored-by: hannah <story645@gmail.com>
@mattymo30 @story645
Update galleries/users_explain/colors/colormaps.py
702caaf 
Co-authored-by: hannah <story645@gmail.com>
@mattymo30 @story645
Update galleries/users_explain/colors/colorbar_only.py
2da575d 
Co-authored-by: hannah <story645@gmail.com>
@mattymo30 @story645
Update galleries/users_explain/axes/autoscale.py
7998a6f 
Co-authored-by: hannah <story645@gmail.com>
@mattymo30 @story645
Update galleries/users_explain/colors/colormap-manipulation.py
3a23c1f 
Co-authored-by: hannah <story645@gmail.com>
story645
story645 approved these changes Nov 27, 2023
View reviewed changes
Copy link
Member
@story645 story645 left a comment

Choose a reason for hiding this comment

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

Going by Jody's comment, looks good to me so just needs the flake8 fix and should be good to go.

@mattymo30 @story645
Update galleries/users_explain/colors/colormaps.py
97982dd 
Co-authored-by: hannah <story645@gmail.com>
@QuLogic QuLogic added this to the v3.8-doc milestone Dec 2, 2023
@QuLogic QuLogic merged commit 161d47b into matplotlib:main Dec 2, 2023
@meeseeksmachine meeseeksmachine mentioned this pull request Dec 2, 2023
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 2, 2023
@mattymo30 @meeseeksmachine
Backport PR matplotlib#27325: Fixing Sentence Case on Section Titles …
08cc8cb 
…in users_explain
@meeseeksmachine meeseeksmachine mentioned this pull request Dec 2, 2023
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 2, 2023
@mattymo30 @meeseeksmachine
Backport PR matplotlib#27325: Fixing Sentence Case on Section Titles …
f0d7435 
…in users_explain
rcomer added a commit that referenced this pull request Dec 2, 2023
@rcomer
Merge pull request #27421 from meeseeksmachine/auto-backport-of-pr-27…
3655ff8 
…325-on-v3.8.2-doc

Backport PR #27325 on branch v3.8.2-doc (Fixing Sentence Case on Section Titles in users_explain)
rcomer added a commit that referenced this pull request Dec 2, 2023
@rcomer
Merge pull request #27420 from meeseeksmachine/auto-backport-of-pr-27…
77f79fa 
…325-on-v3.8.x

Backport PR #27325 on branch v3.8.x (Fixing Sentence Case on Section Titles in users_explain)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@story645 story645 story645 approved these changes

@melissawm melissawm melissawm approved these changes

Assignees
No one assigned
Labels
Documentation: user guide files in galleries/users_explain or doc/users
Projects
None yet
Milestone
v3.8-doc
Development

Successfully merging this pull request may close these issues.
6 participants
@mattymo30 @oscargus @story645 @jklymak @melissawm @QuLogic
0