diff options
| author | Éric Araujo <merwok@netwok.org> | 2011-09-01 18:45:50 +0200 |
|---|---|---|
| committer | Éric Araujo <merwok@netwok.org> | 2011-09-01 18:45:50 +0200 |
| commit | 8ab3a1d7350b8fae8cf4ae4c726035152e3f59ab (patch) | |
| tree | a5d97edcd2da30a6327822210fe7eb07ac5e4110 | |
| parent | ec9a5f6399a02da00249501014a2a7207c267a0e (diff) | |
| download | cpython-git-8ab3a1d7350b8fae8cf4ae4c726035152e3f59ab.tar.gz | |
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.
| -rw-r--r-- | Doc/documenting/markup.rst | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index c005d0c9e7..ce39d3bcaf 100644 --- a/Doc/documenting/markup.rst +++ b/Doc/documenting/markup.rst @@ -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 |