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.

Sign up for GitHub

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

DOC: add/fix Timedeltas docstrings #51229

Merged
merged 3 commits into from
Feb 9, 2023
Merged

DOC: add/fix Timedeltas docstrings #51229

merged 3 commits into from
Feb 9, 2023

Conversation

abonte
Copy link
Contributor

@abonte abonte commented Feb 8, 2023

Add docstrings:

  • Timedelta.components
  • Timedelta.days

Fix example:

  • Timedeltas.seconds

mroeschke
mroeschke reviewed Feb 8, 2023
View reviewed changes
Copy link
Member

@mroeschke mroeschke left a comment

Choose a reason for hiding this comment

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

Thanks could you remove the methods you added examples to from this list?

pandas/ci/code_checks.sh

Line 87 in 797cd03

$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01 --ignore_functions \

@mroeschke mroeschke added Docs Timedelta Timedelta data type labels Feb 8, 2023
@MarcoGorelli MarcoGorelli added this to the 2.0 milestone Feb 9, 2023
MarcoGorelli
MarcoGorelli approved these changes Feb 9, 2023
View reviewed changes
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

thanks @abonte

@MarcoGorelli MarcoGorelli merged commit d0fbeb4 into pandas-dev:main Feb 9, 2023
@abonte abonte deleted the update-timedelta-docstring branch February 9, 2023 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mroeschke mroeschke mroeschke left review comments

@MarcoGorelli MarcoGorelli MarcoGorelli approved these changes

Assignees
No one assigned
Labels
Docs Timedelta Timedelta data type
Projects
None yet
Milestone
2.0
Development

Successfully merging this pull request may close these issues.
3 participants
@abonte @mroeschke @MarcoGorelli