]> 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 17:56:04 +0000 (19:56 +0200)
committerÉric Araujo <merwok@netwok.org>
Thu, 1 Sep 2011 17:56:04 +0000 (19:56 +0200)
Doc/documenting/markup.rst

index 4f1fcae9e75b3a99fb57e3a80597a256f7b61992..25801c7564094373b4f01381f18e0a9a7a4d0e4d 100644 (file)
@@ -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