summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2011-09-01 17:56:04 (GMT)
committerÉric Araujo <merwok@netwok.org>2011-09-01 17:56:04 (GMT)
commit2c378ae364df3d8cf263db022b9c6a92a0f6ccb1 (patch)
tree58b2e659cd5df55e4e2eb4a0e0d65d4f4d046b8c
parent7ce05e07c01378a7187135cc2df89ecd6e57f9ab (diff)
downloadcpython-2c378ae364df3d8cf263db022b9c6a92a0f6ccb1.zip
cpython-2c378ae364df3d8cf263db022b9c6a92a0f6ccb1.tar.gz
cpython-2c378ae364df3d8cf263db022b9c6a92a0f6ccb1.tar.bz2
Document that True/False/None don’t use :keyword: in doc
-rw-r--r--Doc/documenting/markup.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index 4f1fcae..25801c7 100644
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -472,7 +472,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