Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: Document that datetime64 is a dtype. #14641

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
wants to merge 1 commit into from

Conversation

dstansby
Copy link
Contributor

@dstansby dstansby commented Oct 4, 2019

Fixes #10039

@dstansby dstansby marked this pull request as ready for review October 4, 2019 13:59
@charris charris changed the title Add datetime64 doc DOC: Document that datetime64 is a dtype. Oct 6, 2019
@@ -6831,6 +6831,11 @@ def add_newdoc_for_scalar_type(obj, fixed_aliases, doc):
numbers.
""")

add_newdoc_for_scalar_type('datetime64', [''],
"""
Datetime type.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could use a longer explanation. Look at some of the other dtype docstrings in this file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy if someone wants to suggest a better description, but I'm struggling to come up with anything myself.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Datetime type, stored as a 64-bit integer. Functionally compatible with datetime.datetime"

I think single backticks around datetime.datetime will create a link to the python documentation. Should also document timedelta64

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dstansby ping

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Afraid I don't have the bandwidth to pick this up at the moment - if someone else wants to push to my branch or open a replacement PR then feel free.

@eric-wieser
Copy link
Member

I don't think this is sufficient to create an intersphinx link - no doc page is emitted for any of the scalar types.

@dstansby dstansby closed this Apr 18, 2020
@dstansby dstansby deleted the datetime64-doc branch April 18, 2020 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

datetime64 not present in intersphinx inventory
4 participants