[Python-checkins] cpython (3.2): Document that True/False/None don’t use :keyword: in doc.

[eric.araujo]

http://hg.python.org/cpython/rev/f2e0481f28db
changeset:   72184:f2e0481f28db
branch:      3.2
user:        Éric Araujo <merwok at netwok.org>
date:        Thu Sep 01 18:45:50 2011 +0200
summary:
  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.

files:
  Doc/documenting/markup.rst |  5 ++++-
  1 files changed, 4 insertions(+), 1 deletions(-)


diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -513,7 +513,10 @@
 
 .. 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
 

-- 
Repository URL: http://hg.python.org/cpython