[New-bugs-announce] [issue15580] fix True/False/None reST markup

Chris Jerdonek report at bugs.python.org
Wed Aug 8 03:49:38 CEST 2012

New submission from Chris Jerdonek:

The Dev Guide says not to markup True, False, and None in the documentation in a way that generates a link (e.g. ":const:`True`") because "they’re fundamental to the language and should be known to any programmer":


Rather, it says to use "``True``" (and similarly for False and None):

This issue is to update the documentation to conform to this guidance.

While working on the documentation, I noticed many occurrences of ":const:`True`", for example.  See here for some examples, where you can see the hyperlinks:


assignee: docs at python
components: Documentation
messages: 167648
nosy: cjerdonek, docs at python
priority: normal
severity: normal
status: open
title: fix True/False/None reST markup

Python tracker <report at bugs.python.org>

More information about the New-bugs-announce mailing list