[issue36960] Make datetime docs more user-friendly
New submission from Brad Solomon <brad.solomon.1124@gmail.com>: 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. ---------- assignee: docs@python components: Documentation messages: 342813 nosy: bsolomon1124, docs@python priority: normal pull_requests: 13321 severity: normal status: open title: Make datetime docs more user-friendly type: enhancement versions: Python 3.8 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36960> _______________________________________
Change by Cheryl Sabella <cheryl.sabella@gmail.com>: ---------- nosy: +belopolsky, p-ganssle _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36960> _______________________________________
Cheryl Sabella <cheryl.sabella@gmail.com> added the comment: See also issue8822. ---------- nosy: +cheryl.sabella _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36960> _______________________________________
Paul Ganssle <p.ganssle@gmail.com> added the comment: New changeset 3fb1363fe87a24cdb2ee1dd9746f1c49046af958 by Paul Ganssle (Brad) in branch 'master': Overhaul datetime documentation (GH-13410) https://github.com/python/cpython/commit/3fb1363fe87a24cdb2ee1dd9746f1c49046... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36960> _______________________________________
Change by Paul Ganssle <p.ganssle@gmail.com>: ---------- resolution: -> fixed stage: -> resolved status: open -> closed versions: +Python 3.9 -Python 3.8 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36960> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +15679 pull_request: https://github.com/python/cpython/pull/16056 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36960> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 8976359c598f56825648f4e5397b78c5d14ea13c by Miss Islington (bot) in branch '3.8': Overhaul datetime documentation (GH-13410) https://github.com/python/cpython/commit/8976359c598f56825648f4e5397b78c5d14... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36960> _______________________________________
participants (4)
-
Brad Solomon
-
Cheryl Sabella
-
miss-islington
-
Paul Ganssle