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: Bad links to 'time' in datetime documentation
Type: Stage: resolved
Components: Documentation Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: ezio.melotti Nosy List: docs@python, ezio.melotti, georg.brandl, gjb1002, python-dev
Priority: normal Keywords: patch

Created on 2011-09-30 13:45 by gjb1002, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue13076.diff ezio.melotti, 2011-10-02 08:18 Patch to reference datetime.time explicitly.
Messages (5)
msg144689 - (view) Author: Geoffrey Bache (gjb1002) Date: 2011-09-30 13:45
Reading through the datetime module documentation, various places that refer to "datetime.time" objects are in fact links to the "time" module. They should refer to the appropriate section on the same page.
msg144761 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2011-10-02 08:18
The broken links seem to be only in the "time objects" section, and only in the body of attribute/method directives.

The attached patch fixes the issue by using :class:`~datetime.time` explicitly where the links are broken.

Georg, is this a bug in Sphinx?
msg144762 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2011-10-02 08:23
No, it's not, it's how Sphinx works. Use :class:`.time` to refer to the datetime class.
msg144766 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2011-10-02 09:47
New changeset 854e31d80151 by Ezio Melotti in branch '2.7':
#13076: fix links to datetime.time.
http://hg.python.org/cpython/rev/854e31d80151

New changeset 95689ed69097 by Ezio Melotti in branch '3.2':
#13076: fix links to datetime.time and datetime.datetime.
http://hg.python.org/cpython/rev/95689ed69097

New changeset 175cd2a51ea9 by Ezio Melotti in branch 'default':
#13076: merge with 3.2.
http://hg.python.org/cpython/rev/175cd2a51ea9
msg144768 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2011-10-02 09:49
This should be fixed now, thanks for the report.
FTR with Sphinx 1.0 all the links to :class:`time` and also :class:`datetime` needed to be fixed because they were pointing to the modules, with 0.6 only the :class:`time` in the body of attribute/method directives were broken.
History
Date User Action Args
2022-04-11 14:57:22adminsetgithub: 57285
2011-10-02 09:49:51ezio.melottisetstatus: open -> closed
resolution: fixed
messages: + msg144768

stage: patch review -> resolved
2011-10-02 09:47:24python-devsetnosy: + python-dev
messages: + msg144766
2011-10-02 08:23:17georg.brandlsetmessages: + msg144762
2011-10-02 08:18:23ezio.melottisetfiles: + issue13076.diff

assignee: docs@python -> ezio.melotti

keywords: + patch
nosy: + georg.brandl, ezio.melotti
messages: + msg144761
stage: needs patch -> patch review
2011-09-30 13:48:03r.david.murraysetstage: needs patch
versions: - Python 2.6, Python 3.1, Python 3.4
2011-09-30 13:45:45gjb1002setassignee: docs@python

components: + Documentation
nosy: + docs@python
2011-09-30 13:45:08gjb1002create