classification
Title: Fix formatting of True and False
Type: enhancement Stage: patch review
Components: Documentation Versions: Python 3.9, Python 3.8, Python 3.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, serhiy.storchaka, veky
Priority: normal Keywords: patch

Created on 2019-11-07 19:42 by serhiy.storchaka, last changed 2019-11-08 18:55 by veky.

Pull Requests
URL Status Linked Edit
PR 17083 open serhiy.storchaka, 2019-11-07 19:43
Messages (2)
msg356210 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2019-11-07 19:42
The proposed PR fixes some issues with True and False in the documentation:

* "Return true/false" is replaced with "Return ``True``/``False``" if the function actually returns a bool.

* Fixed formatting of some True and False literals (now in monospace).

* Replaced "True/False" with "true/false" if it can be not only bool.

* Replaced some 1/0 with True/False if it corresponds the code.
msg356254 - (view) Author: Vedran Čačić (veky) * Date: 2019-11-08 18:55
Very nice. I aplaud your return to the original Python terminology, of true and false as adjectives, and True and False as names for specific objects. Perlisms such as `truthy` or `that evaluates as True` simply make my head spin.

I wrote one comment, regarding the case where you have the default value mentioned. Otherwise, I think it is a very nice change.
History
Date User Action Args
2019-11-08 18:55:19vekysetnosy: + veky
messages: + msg356254
2019-11-07 19:43:03serhiy.storchakasetkeywords: + patch
stage: patch review
pull_requests: + pull_request16593
2019-11-07 19:42:20serhiy.storchakacreate