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

Fix part of docstring timedelta #59698 #59722

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ammar-qazi
Copy link
Contributor

Part of 59698

Addresses:

pandas.Timedelta

Added the missing explanations (PRO2) for min, max, and resolution.

Removed:

  • i "pandas.Timedelta.resolution PR02" \
  • i "pandas.Timedelta.min PR02" \
  • i "pandas.Timedelta.resolution PR02" \

from code_checks.sh

p.s. I'm not 100% confident if this is the appropriate way to document these attributes. That said, they're being defined by a class called MinMaxReso, and they don't have their separate definitions per se. So, I found this most appropriate way to document them.

@@ -1835,6 +1835,21 @@ class Timedelta(_Timedelta):
Values for construction in compat with datetime.timedelta.
Numpy ints and floats will be coerced to python ints and floats.

**Attributes
Copy link
Member

Choose a reason for hiding this comment

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

this is probably fine, but you need to remove the leading **

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review. I've removed the leading **.

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

Successfully merging this pull request may close these issues.

2 participants