This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Fix versionadded/versionchanged documentation directives
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.6, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, georg.brandl, jstasiak, martin.panter, python-dev
Priority: normal Keywords: patch

Created on 2016-02-25 10:09 by jstasiak, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
typos.patch jstasiak, 2016-02-25 10:08 review
Messages (5)
msg260848 - (view) Author: Jakub Stasiak (jstasiak) * Date: 2016-02-25 10:08
A double colon seems to be required for a directive to work, please find a patch attached.
msg260851 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-02-25 11:35
Thanks for finding these. I presume they are also applicable to 3.5.

There is a similar problem with the range() documentation:

./Doc/library/stdtypes.rst:1301:   .. data: start
./Doc/library/stdtypes.rst:1306:   .. data: stop
./Doc/library/stdtypes.rst:1310:   .. data: step

Unfortunately it looks like this error causes the text to be silently dropped from the output. There are scripts that check for other errors (make -C Doc/ suspicious check), but it seems this error is not picked up.
msg260879 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2016-02-25 19:08
These are interpreted as comments by docutils. "make suspicious" only checks for markup erroneously remaining in the output. "make check", which runs tools/rstlint.py, should pick them up though.
msg260880 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2016-02-25 19:15
Ok, that was a bug in rstlint. Fixed now - and now I can find quite a few instances, will fix them (most of them are in this patch).
msg260881 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-02-25 19:18
New changeset 1f8dc6f2b171 by Georg Brandl in branch '3.5':
Closes #26435: fix syntax in directives. Thanks to Jakub Stasiak.
https://hg.python.org/cpython/rev/1f8dc6f2b171
History
Date User Action Args
2022-04-11 14:58:28adminsetgithub: 70622
2016-02-25 19:18:28python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg260881

resolution: fixed
stage: patch review -> resolved
2016-02-25 19:15:39georg.brandlsetmessages: + msg260880
2016-02-25 19:08:05georg.brandlsetnosy: + georg.brandl
messages: + msg260879
2016-02-25 11:35:01martin.pantersetversions: + Python 3.5
nosy: + martin.panter

messages: + msg260851

stage: patch review
2016-02-25 10:09:00jstasiakcreate