From: Éric Araujo <merwok@netwok.org>
Date: Thu, 1 Sep 2011 16:45:50 +0000 (+0200)
Subject: Document that True/False/None don’t use :keyword: in doc.
X-Git-Tag: v3.3.0a1~1580^2^2~6
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8ab3a1d7350b8fae8cf4ae4c726035152e3f59ab;p=python

Document that True/False/None don’t use :keyword: in doc.

This was discussed some months ago on python-dev.  Having tons of links
to the definition of True would be annoying, contrary to links to e.g.
the nonlocal or with statements doc.
---

diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index c005d0c9e7..ce39d3bcaf 100644
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -513,7 +513,10 @@ in a different style:
 
 .. describe:: keyword
 
-   The name of a keyword in Python.
+   The name of a Python keyword.  Using this role will generate a link to the
+   documentation of the keyword.  ``True``, ``False`` and ``None`` do not use
+   this role, but simple code markup (````True````), given that they're
+   fundamental to the language and should be known to any programmer.
 
 .. describe:: mailheader