Mailing List Archive: Python: Bugs

[issue8810] TZ offset description is unclear in docs

Index | Next | Previous | View Threaded

report at bugs

Aug 19, 2012, 8:15 PM

Post #1 of 3 (78 views)
Permalink

[issue8810] TZ offset description is unclear in docs

Ben Finney added the comment:

Here is an updated patch. I examined the implementation in the code for UTC offset and DST handling, and updated the code comments, the docstrings, and the library documentation.

----------
keywords: +patch
nosy: +bignose, ncoghlan
Added file: http://bugs.python.org/file26908/issue8810_reconcile_docs.patch

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue8810>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Aug 19, 2012, 9:44 PM

Post #2 of 3 (71 views)
Permalink

[issue8810] TZ offset description is unclear in docs [In reply to]

Nick Coghlan added the comment:

It turns out these particular docstrings are duplicated all over the place, as time and datetime both wrap the tzinfo method, and there is both the tzinfo ABC as well as the concrete fixed offset subclasses, and this happens in both C and Python.

Ben's patch currently only covers the docstrings for the Python tzinfo ABC implementation

----------

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue8810>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Aug 19, 2012, 11:44 PM

Post #3 of 3 (71 views)
Permalink

[issue8810] TZ offset description is unclear in docs [In reply to]

Ben Finney added the comment:

Attached is a patch which is more comprehensive (covering the additional locations pointed out to me by ncoghlan), and also consolidating the details into the library documentation so they're not verbosely repeated in so many places.

I agree with Nick's position that the docstrings are not the place to go into great detail about the significance and background of the issues. So the docstrings in this patch are accurate, but terse; the details are in the library documentation.

----------
Added file: http://bugs.python.org/file26911/issue8810_reconcile_docs.patch

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue8810>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

Index | Next | Previous | View Threaded

Interested in having your list archived? Contact Gossamer Threads