]> granicus.if.org Git - python/commitdiff
Document that True/False/None don’t use :keyword: in doc.
authorÉric Araujo <merwok@netwok.org>
Thu, 1 Sep 2011 16:45:50 +0000 (18:45 +0200)
committerÉric Araujo <merwok@netwok.org>
Thu, 1 Sep 2011 16:45:50 +0000 (18:45 +0200)
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.

Doc/documenting/markup.rst

index c005d0c9e700799e8ec0937888b8111ac5443e93..ce39d3bcaf1b0ee28e9f5ca6c51f0f84c2211a24 100644 (file)
@@ -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