Skip to content

Docstrings for some methods in the datetime module are not very clear or helpful #97517

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.

Sign up for GitHub

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
Open
MaddyGuthridge opened this issue Sep 24, 2022 · 2 comments · May be fixed by #31761
Open

Docstrings for some methods in the datetime module are not very clear or helpful #97517

MaddyGuthridge opened this issue Sep 24, 2022 · 2 comments · May be fixed by #31761
Labels
extension-modules C modules in the Modules dir stdlib Python modules in the Lib dir triaged The issue has been accepted as valid by a triager.

Comments

@MaddyGuthridge
Copy link

MaddyGuthridge commented Sep 24, 2022 •
edited by bedevere-app bot
Loading

Documentation

The strftime, strptime and ctime methods of the datetime and time objects have poor docstrings, which makes it near impossible to write code that interacts with them without referring to the online documentation.

The documentation could be improved greatly by adding information on the specifics of the input/output formats, specifically elaborating on the escape sequences used.

Linked PRs
@MaddyGuthridge MaddyGuthridge added the docs Documentation in the Doc dir label Sep 24, 2022
@MaddyGuthridge MaddyGuthridge linked a pull request Sep 24, 2022 that will close this issue
Open
@ericvsmith ericvsmith changed the title Documentation for some methods in the datetime module are not very clear or helpful Docstrings for some methods in the datetime module are not very clear or helpful Sep 24, 2022
@encukou encukou added stdlib Python modules in the Lib dir and removed docs Documentation in the Doc dir labels Mar 10, 2025
@picnixz picnixz added the triaged The issue has been accepted as valid by a triager. label Mar 10, 2025
@StanFromIreland
Copy link
Contributor

Duplicate of: #84823

@StanFromIreland StanFromIreland mentioned this issue Apr 10, 2025
Open
@StanFromIreland
Copy link
Contributor

These are still duplicated.

@picnixz picnixz added the extension-modules C modules in the Modules dir label Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
extension-modules C modules in the Modules dir stdlib Python modules in the Lib dir triaged The issue has been accepted as valid by a triager.
Projects
Date and time issues 🕰️
Status: No status
Milestone
No milestone
4 participants
@encukou @picnixz @MaddyGuthridge @StanFromIreland