-
-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Tweak examples capitalization/punctuation. #23321
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
(Looking at the list of titles at https://matplotlib.org/stable/gallery/index.html the weak consensus seems to be using no titlecase (which is also my preference), but there's certainly room for improved consistency there as well.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a lot of Foo Demos; probably worth just doing a mass change as a single PR instead of doing it piecemeal here (together with deciding whether we want to style or to link the API name in the title as well (IIRC @QuLogic preferred styling but not linking in titles for the changelog, perhaps he can comment on that).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would handle Foo Demos separately. Im also very sceptical on using "Demo" at all.
Linking in titles usually doesn't render well because the and <h*> CSS fight.
For a similar reason, I would not try to style section titles at all. They can appear as links in TOCs, and for gallery entries in particular their titles are used in the overview tiles as links as well.
(Looking at the list of titles at
https://matplotlib.org/stable/gallery/index.html the weak consensus
seems to be using no titlecase (which is also my preference), but
there's certainly room for improved consistency there as well.)
PR Summary
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).