-
-
Notifications
You must be signed in to change notification settings - Fork 895
Add boolean to the style guide #1636
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
base: main
Are you sure you want to change the base?
Conversation
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.
11 now:-)
Lowercase in most cases. | ||
Uppercase for Boolean mathematics and Boolean logic. |
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.
By my reading of the Google guidance, this should be:
Lowercase in most cases. | |
Uppercase for Boolean mathematics and Boolean logic. | |
Lowercase in most cases. | |
Uppercase for *Boolean mathematics* and *Boolean logic*. | |
To refer to the Python or C data type, prefer using the exact, abbreviated | |
name with appropriate markup (for example, ``:type:`bool```). |
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.
To avoid saying "case" twice in one line
Lowercase in most cases. | |
Uppercase for Boolean mathematics and Boolean logic. | |
Lowercase in most instances. | |
Uppercase for *Boolean mathematics* and *Boolean logic*. | |
To refer to the Python or C data type, prefer using the exact, | |
abbreviated name with appropriate markup (for example, ``:type:`bool```). |
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 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
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 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.
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