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

[eric.araujo]

http://hg.python.org/cpython/rev/d4b8dc7e0699
changeset:   72198:d4b8dc7e0699
branch:      2.7
user:        Éric Araujo <merwok at netwok.org>
date:        Thu Sep 01 19:56:04 2011 +0200
summary:
  Document that True/False/None don’t use :keyword: in 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
@@ -472,7 +472,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