Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

Merged
merged 1 commit into from
Jun 22, 2022
Merged

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Jun 22, 2022

(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

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

(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.)
@@ -1,10 +1,10 @@
"""
r"""
====================
EventCollection Demo
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
EventCollection Demo
EventCollection demo

?

Copy link
Contributor Author

@anntzer anntzer Jun 22, 2022

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).

Copy link
Member

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.

@timhoffm timhoffm added this to the v3.6.0 milestone Jun 22, 2022
@timhoffm timhoffm merged commit 191b6ed into matplotlib:main Jun 22, 2022
@anntzer anntzer deleted the ex branch June 22, 2022 14:19
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