Skip to content

Add boolean to the style guide#1636

Merged
hugovk merged 2 commits into
python:mainfrom
hugovk:style-guide-boolean
Aug 17, 2025
Merged

Add boolean to the style guide#1636
hugovk merged 2 commits into
python:mainfrom
hugovk:style-guide-boolean

Conversation

@hugovk

@hugovk hugovk commented Aug 15, 2025

Copy link
Copy Markdown
Member

Fixes python/docs-community#129, which has been open for 11 months with 10 votes in favour of the Google guidance (Ned's comment + 9 👍), and no down votes, and no other suggestions.


📚 Documentation preview 📚: https://cpython-devguide--1636.org.readthedocs.build/documentation/style-guide/#specific-words

@StanFromIreland StanFromIreland left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

11 now:-)

Comment thread documentation/style-guide.rst Outdated

@AA-Turner AA-Turner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I didn't downvote the comment (that seems too harsh), but I will register support for properly capitalising Boolean as a proper noun. Three of the four style guides quoted say to capitalise, abeit one of them giving the option not to. Google's prefers using the formatting of the type (i.e. bool) where possible, and then diverges from the others in terms of spelling.

I also disagree with the notion that capitalising it is pedantic or distracting, we capitalise other proper nouns properly (e.g. Python, C API). English is a language with lots of capitalisation in places, not just at the start of sentences.

However, if this is the will of the people I won't stand in the way of progress...

A

@willingc willingc left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I approve with adoption of @encukou / @AA-Turner's suggestion.

In general, I think using interchangeably is fine since there is no industry consensus of capitalization.

@ezio-melotti ezio-melotti left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM (once the suggested comments are applied).

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@hugovk

hugovk commented Aug 17, 2025

Copy link
Copy Markdown
Member Author

Yes to capitalising proper nouns, but eponyms aren't so clear cut and tend to become lowercase after enough time has passed.

Some examples:

  • atlas, bloomers, bowdlerize, braille, casanova, cesarean, chauvinism, daguerreotype, derrick, diesel, gerrymander, guppy, hoover, jeremiad, jeroboam, leotard, lynch, martinet, mausoleum, narcissist, nicotine, poinsettia, quixotic, sideburns, tarmac, teddy bear, sadism, saxophone, shrapnel, volt, watt.

@hugovk hugovk merged commit 4cb6ddb into python:main Aug 17, 2025
4 checks passed
@hugovk hugovk deleted the style-guide-boolean branch August 17, 2025 17:54
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.

Style guide: boolean or Boolean?

6 participants