Skip to content
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

Use sentence case for titles #1162

Merged
merged 3 commits into from
Sep 14, 2023
Merged

Use sentence case for titles #1162

merged 3 commits into from
Sep 14, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Sep 13, 2023

The devguide's style guide says:

In the Python documentation, the use of sentence case in section titles is preferable, but consistency within a unit is more important than following this rule. If you add a section to a chapter where most sections are in title case, you can either convert all titles to sentence case or use the dominant style in the new section title.

The devguide has a wide range within units, many pages freely mixing both styles. You can see at https://devguide.python.org/#full-table-of-contents

I think the devguide, and at the very least its style guide, should set an example with sentence case.


📚 Documentation preview 📚: https://cpython-devguide--1162.org.readthedocs.build/

Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

Thanks!

A

triage/labels.rst Outdated Show resolved Hide resolved
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@hugovk hugovk merged commit cb39eca into python:main Sep 14, 2023
2 checks passed
@hugovk hugovk deleted the sentence-case branch September 14, 2023 05:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants