Skip to content

Capitalization fixes in example section titles. #21086

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
Sep 19, 2021

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Sep 16, 2021

PR Summary

(See https://matplotlib.org/devdocs/users/index.html for how it currently looks.)

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • 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).

Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

I don't think this is an improvement.

Mixing in some verbatim titles in the toc looks odd:
https://63548-1385122-gh.circle-artifacts.com/0/doc/build/html/users/index.html

Even more, this leads to completely different title formatting in the gallery itself:
https://63548-1385122-gh.circle-artifacts.com/0/doc/build/html/gallery/index.html#pyplot

I'd rather leave these unformatted here.

@anntzer
Copy link
Contributor Author

anntzer commented Sep 16, 2021

I removed the double backquotes (but kept the uncapitalization, and the underscore in axes_grid1), perhaps that'll look better?

@timhoffm
Copy link
Member

@anntzer forgot to push?

@anntzer
Copy link
Contributor Author

anntzer commented Sep 19, 2021

oops, indeed.

@timhoffm timhoffm added this to the v3.5.0 milestone Sep 19, 2021
@timhoffm timhoffm merged commit 4ef2161 into matplotlib:master Sep 19, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 19, 2021
@anntzer anntzer deleted the esc branch September 19, 2021 12:46
timhoffm added a commit that referenced this pull request Sep 19, 2021
…086-on-v3.5.x

Backport PR #21086 on branch v3.5.x (Capitalization fixes in example section titles.)
tacaswell pushed a commit to tacaswell/matplotlib that referenced this pull request Oct 12, 2021
Capitalization fixes in example section titles.
tacaswell pushed a commit that referenced this pull request Oct 20, 2021
Capitalization fixes in example section titles.
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.

2 participants