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

DOC: update DatetimeTZDtype unit limitation #58213

Merged
merged 2 commits into from
Apr 12, 2024

Conversation

yokomotod
Copy link
Contributor

@yokomotod yokomotod commented Apr 10, 2024

@@ -699,7 +699,7 @@ class DatetimeTZDtype(PandasExtensionDtype):
----------
unit : str, default "ns"
The precision of the datetime data. Currently limited
Copy link
Member

Choose a reason for hiding this comment

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

I think we should consider deleting "Currently limited" since there are 4 possible options now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Aloqeely thank you for your review.

How about

The precision of the datetime data. Only supports
``"s"``, ``"ms"``, ``"us"``, ``"ns"``.

as same as error message?

if unit not in ["s", "ms", "us", "ns"]:
    raise ValueError("DatetimeTZDtype only supports s, ms, us, ns units")

Copy link
Member

Choose a reason for hiding this comment

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

Yes sure, Only supports and Valid options are both sound good to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated!

483b9cc

@mroeschke mroeschke added the Docs label Apr 10, 2024
@datapythonista
Copy link
Member

/preview

Copy link
Contributor

Website preview of this PR available at: https://pandas.pydata.org/preview/pandas-dev/pandas/58213/

@mroeschke mroeschke added this to the 3.0 milestone Apr 12, 2024
@mroeschke mroeschke merged commit b9bfc01 into pandas-dev:main Apr 12, 2024
45 of 46 checks passed
@mroeschke
Copy link
Member

Thanks @yokomotod

@yokomotod yokomotod deleted the doc-datetime-tz-dtype-unit branch April 12, 2024 18:52
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
* doc: update DatetimeTZDtype unit limitation

* fix description
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: DatetimeTZDtype unit limitation is not updated
4 participants