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: broken links on Lib/datetime.py docstring
Type: enhancement Stage: resolved
Components: Documentation, Library (Lib) Versions: Python 3.3, Python 3.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: ezio.melotti Nosy List: belopolsky, docs@python, ezio.melotti, fdrake, python-dev, tim.peters, tshepang
Priority: normal Keywords: patch

Created on 2013-03-29 07:54 by tshepang, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue17571.diff ezio.melotti, 2013-04-01 20:20 review
Messages (6)
msg185494 - (view) Author: Tshepang Lekhonkhobe (tshepang) * Date: 2013-03-29 07:54
There are 2 broken links at the beginning of Lib/datetime.py.

One other thing, maybe "prototype implemented in Python" is an outdated and/or needless statement?
msg185518 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-03-29 20:57
This is the module docstring:
"""Concrete date/time and related types -- prototype implemented in Python.

See http://www.zope.org/Members/fdrake/DateTimeWiki/FrontPage

See also http://dir.yahoo.com/Reference/calendars/

For a primer on DST, including many current DST rules, see
http://webexhibits.org/daylightsaving/

For more about DST than you ever wanted to know, see
ftp://elsie.nci.nih.gov/pub/

Sources for time zone and DST data: http://www.twinsun.com/tz/tz-link.htm

This was originally copied from the sandbox of the CPython CVS repository.
Thanks to Tim Peters for suggesting using it.
"""

The first link is broken, the following two links look like more or less random page that can be found by googling, the .gov site might have been useful but it's broken, and the last link looks OK.
I think it would be better to replace the whole docstring with something more descriptive.  I'm not sure those links should be kept at all.
msg185519 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2013-03-29 21:15
Let's just update the docstring:

"""Concrete date/time and related types.

See also http://dir.yahoo.com/Reference/calendars/

For a primer on DST, including many current DST rules, see
http://webexhibits.org/daylightsaving/

Sources for time zone and DST data: http://www.twinsun.com/tz/tz-link.htm

This was originally copied from the sandbox of the CPython CVS repository.
Thanks to Tim Peters for suggesting using it.
"""
msg185521 - (view) Author: Alexander Belopolsky (belopolsky) * (Python committer) Date: 2013-03-29 21:56
Shouldn't we link to IANA for timezones information?

http://www.iana.org/time-zones/repository/tz-link.html
msg185766 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-04-01 20:20
Here's a patch.
msg186766 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-04-13 17:13
New changeset 70f9f6752d28 by Ezio Melotti in branch '3.3':
#17571: remove broken links in datetime.py docstring.
http://hg.python.org/cpython/rev/70f9f6752d28

New changeset 0d2c364c7e5d by Ezio Melotti in branch 'default':
#17571: merge with 3.3.
http://hg.python.org/cpython/rev/0d2c364c7e5d
History
Date User Action Args
2022-04-11 14:57:43adminsetgithub: 61771
2013-04-13 17:13:38ezio.melottisetstatus: open -> closed
assignee: docs@python -> ezio.melotti
stage: commit review -> resolved
resolution: fixed
versions: + Python 3.3
2013-04-13 17:13:05python-devsetnosy: + python-dev
messages: + msg186766
2013-04-01 20:20:07ezio.melottisetfiles: + issue17571.diff
messages: + msg185766

keywords: + patch
type: enhancement
stage: commit review
2013-03-29 21:56:39belopolskysetmessages: + msg185521
2013-03-29 21:15:58fdrakesetnosy: + fdrake
messages: + msg185519
2013-03-29 20:57:19ezio.melottisetnosy: + ezio.melotti, belopolsky, tim.peters
messages: + msg185518
2013-03-29 07:54:26tshepangcreate