broken links on Lib/datetime.py docstring

[tshepang]

BPO	17571
Nosy	@tim-one, @freddrake, @abalkin, @ezio-melotti
Files	issue17571.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/ezio-melotti'
closed_at = <Date 2013-04-13.17:13:38.479>
created_at = <Date 2013-03-29.07:54:26.767>
labels = ['type-feature', 'library', 'docs']
title = 'broken links on Lib/datetime.py docstring'
updated_at = <Date 2013-04-13.17:13:38.478>
user = 'https://bugs.python.org/tshepang'

bugs.python.org fields:

activity = <Date 2013-04-13.17:13:38.478>
actor = 'ezio.melotti'
assignee = 'ezio.melotti'
closed = True
closed_date = <Date 2013-04-13.17:13:38.479>
closer = 'ezio.melotti'
components = ['Documentation', 'Library (Lib)']
creation = <Date 2013-03-29.07:54:26.767>
creator = 'tshepang'
dependencies = []
files = ['29648']
hgrepos = []
issue_num = 17571
keywords = ['patch']
message_count = 6.0
messages = ['185494', '185518', '185519', '185521', '185766', '186766']
nosy_count = 7.0
nosy_names = ['tim.peters', 'fdrake', 'belopolsky', 'ezio.melotti', 'docs@python', 'tshepang', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue17571'
versions = ['Python 3.3', 'Python 3.4']

[tshepang]

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?

[ezio-melotti]

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.

[freddrake]

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.
"""

[abalkin]

Shouldn't we link to IANA for timezones information?

http://www.iana.org/time-zones/repository/tz-link.html

[ezio-melotti]

Here's a patch.

[python-dev]

New changeset 70f9f6752d28 by Ezio Melotti in branch '3.3':
bpo-17571: remove broken links in datetime.py docstring.
http://hg.python.org/cpython/rev/70f9f6752d28

New changeset 0d2c364c7e5d by Ezio Melotti in branch 'default':
bpo-17571: merge with 3.3.
http://hg.python.org/cpython/rev/0d2c364c7e5d