Skip to content

pd.to_datetime docstring needs upgrade #17973

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

Closed
tdpetrou opened this issue Oct 25, 2017 · 2 comments
Closed

pd.to_datetime docstring needs upgrade #17973

tdpetrou opened this issue Oct 25, 2017 · 2 comments
Labels
Datetime Datetime data dtype Docs
Milestone

Comments

@tdpetrou
Copy link
Contributor

Problem description

pd.to_datetime has a very short non-descriptive docstring: Convert argument to datetime.

Using the term datetime is horribly confusing as there is a Python datetime, a NumPy datetime64 and a pandas Timestamp. Although, there is better documentation under the parameters, this needs to be expanded to more than 4 words.

Expected Output

Along with a more thorough explanation, It would be nice if there was consistency with how pandas refers to the triple-headed monster, datetime, datetime64 and Timestamp.

@TomAugspurger TomAugspurger added this to the Next Major Release milestone Oct 25, 2017
@TomAugspurger TomAugspurger added the Datetime Datetime data dtype label Oct 25, 2017
@AdamShamlian
Copy link
Contributor

I'd gladly chip in on the docstring, but I hesitate to contribute a larger handling of "the triple-headed monster." I'd rather leave that to a) another PR against general DOCS and b) someone with much greater context for where pandas has been and where its headed in that regard.

@mroeschke
Copy link
Member

Closed by #42494

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Datetime Datetime data dtype Docs
Projects
None yet
Development

No branches or pull requests

5 participants