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

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

Open
MiguelGuthridge opened this issue Sep 24, 2022 · 0 comments · May be fixed by #31761
Open

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

MiguelGuthridge opened this issue Sep 24, 2022 · 0 comments · May be fixed by #31761
Labels
docs Documentation in the Doc dir

Comments

@MiguelGuthridge
Copy link

MiguelGuthridge commented Sep 24, 2022 •
edited

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.
@MiguelGuthridge MiguelGuthridge added the docs Documentation in the Doc dir label Sep 24, 2022
@MiguelGuthridge MiguelGuthridge 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve docstrings for strptime and strftime methods in datetime module MiguelGuthridge/cpython
1 participant
@MiguelGuthridge