Author bsolomon1124
Recipients bsolomon1124, docs@python
Date 2019-05-18.20:17:58
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1558210678.84.0.258939294256.issue36960@roundup.psfhosted.org>
In-reply-to
Content
The datetime docs are chalk full of detail.  This is a positive aspect,
and represents a huge amount of work by Tim Peters and A.M. Kuchling.
However, it also may function as an obstacle for beginner readers and
those simply seeking to answer a basic question or see a straightforward
usage example.  Rather than seeing an example-based explanation of
a common use-case, they are bombarded with technical detail and
edge cases.

I propose some restructuring of the datetime docs with the goal of
making them more reader-friendly.  The goal is not to eliminate any
of the detail, but to restructure things so as to bring the "everyday"
parts into more prominent real estate.

The changes here all make an effort to reflect what's espoused by
"Documenting Python" at https://devguide.python.org/documenting/.

I have some additional changes in mind but wanted to put this here now
to gauge receptiveness to the existing changes.
History
Date User Action Args
2019-05-18 20:17:58bsolomon1124setrecipients: + bsolomon1124, docs@python
2019-05-18 20:17:58bsolomon1124setmessageid: <1558210678.84.0.258939294256.issue36960@roundup.psfhosted.org>
2019-05-18 20:17:58bsolomon1124linkissue36960 messages
2019-05-18 20:17:58bsolomon1124create