classification
Title: a little typo in dis.rst; need a non-trivial preceding dot
Type: Stage: resolved
Components: Documentation Versions: Python 3.4, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, n0vicelive, python-dev
Priority: normal Keywords: patch

Created on 2015-03-02 10:42 by n0vicelive, last changed 2015-03-02 14:37 by python-dev. This issue is now closed.

Files
File name Uploaded Description Edit
dis_typo.patch n0vicelive, 2015-03-02 10:42 review
Messages (2)
msg237039 - (view) Author: Gu Zhengxiong (n0vicelive) * Date: 2015-03-02 10:42
it is likely that the author of dis.rst omitted two non-trivial preceding dots.

in the 'Bytecode analysis' section,
both :meth:`dis` and :func:`dis` have no preceding dots before 'dis'.

the dots may be trivial elsewhere, but they are non-trivial here. 
otherwise, the hyperlinks will be unexpectedly targeted to the top of the dis module, rather than the corresponding dis method or function.

ref.
:meth:`.timeit`, where the 'timeit' was preceded by a dot, in timeit.rst.

:)
msg237045 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-03-02 14:37
New changeset 10b563c32f9d by Benjamin Peterson in branch '3.4':
link to the correct dis method or function (closes #23561)
https://hg.python.org/cpython/rev/10b563c32f9d

New changeset 760f222103c7 by Benjamin Peterson in branch 'default':
merge 3.4 (#23561)
https://hg.python.org/cpython/rev/760f222103c7
History
Date User Action Args
2015-03-02 14:37:39python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg237045

resolution: fixed
stage: resolved
2015-03-02 10:42:30n0vicelivecreate