Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make datetime docs more user-friendly #81141

Closed
bsolomon1124 mannequin opened this issue May 18, 2019 · 4 comments
Closed

Make datetime docs more user-friendly #81141

bsolomon1124 mannequin opened this issue May 18, 2019 · 4 comments
Labels
3.9 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@bsolomon1124
Copy link
Mannequin

bsolomon1124 mannequin commented May 18, 2019

BPO 36960
Nosy @abalkin, @pganssle, @csabella, @miss-islington, @bsolomon1124
PRs
  • bpo-36960: Make datetime docs more user-friendly #13410
  • [3.8] bpo-36960: Overhaul datetime documentation (GH-13410) #16056
    		•

    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 = None
closed_at = <Date 2019-09-11.09:25:16.295>
created_at = <Date 2019-05-18.20:17:58.825>
labels = ['type-feature', '3.9', 'docs']
title = 'Make datetime docs more user-friendly'
updated_at = <Date 2019-09-12.14:37:39.469>
user = 'https://github.com/bsolomon1124'

    bugs.python.org fields:

    activity = <Date 2019-09-12.14:37:39.469>
actor = 'miss-islington'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-09-11.09:25:16.295>
closer = 'p-ganssle'
components = ['Documentation']
creation = <Date 2019-05-18.20:17:58.825>
creator = 'bsolomon1124'
dependencies = []
files = []
hgrepos = []
issue_num = 36960
keywords = []
message_count = 4.0
messages = ['342813', '342814', '351774', '352180']
nosy_count = 6.0
nosy_names = ['belopolsky', 'docs@python', 'p-ganssle', 'cheryl.sabella', 'miss-islington', 'bsolomon1124']
pr_nums = ['13410', '16056']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue36960'
versions = ['Python 3.9']
    @bsolomon1124
    Copy link
    Mannequin Author

    bsolomon1124 mannequin commented May 18, 2019

    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.

    @bsolomon1124 bsolomon1124 mannequin added the 3.8 only security fixes label May 18, 2019
    @bsolomon1124 bsolomon1124 mannequin assigned docspython May 18, 2019
    @bsolomon1124 bsolomon1124 mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels May 18, 2019
    @csabella
    Copy link
    Contributor

    See also bpo-8822.

    @pganssle
    Copy link
    Member

    New changeset 3fb1363 by Paul Ganssle (Brad) in branch 'master':
    Overhaul datetime documentation (GH-13410)
    3fb1363

    @pganssle pganssle added 3.9 only security fixes and removed 3.8 only security fixes labels Sep 11, 2019
    @miss-islington
    Copy link
    Contributor

    New changeset 8976359 by Miss Islington (bot) in branch '3.8':
    Overhaul datetime documentation (GH-13410)
    8976359

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.9 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @pganssle @csabella @miss-islington