DOC: Updating the timedeltas.seconds docstring for Issue #50969 #51522
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
rmhowe425
commented
Feb 21, 2023
rmhowe425
commented
- closes DOC: seconds attribute of timedelta surprises and no warning is given in the docs #50969
rmhowe425
changed the title
MarcoGorelli
suggested changes
Feb 21, 2023
There was a problem hiding this comment.
thanks for working on this - I think all that's needed is to link total_seconds in the See Also section, something like
See Also
--------
Timedelta.components : Return all attributes with assigned values
(i.e. days, hours, minutes, seconds, milliseconds, microseconds,
nanoseconds).
Timedelta.total_seconds : Express the TimeDelta as total number of seconds.
|
I have updated the documentation based on your feedback. Thanks for the help! |
pandas/_libs/tslibs/timedeltas.pyx
Outdated
Comment on lines
1068
to
1071
| Whenever a negative timedelta is calculate, the `seconds` method is represented | ||
| as the difference of 86400 seconds (24 hours) minus the absolute value | ||
| of the calculated timedelta. To retrieve the expected output, the | ||
| `total_seconds()` method should be called instead |
There was a problem hiding this comment.
I think we can remove this, the 'see also' should be sufficient
There was a problem hiding this comment.
Okay! Removing lines 1068 - 1071 and pushing again
There was a problem hiding this comment.
@MarcoGorelli I just updated the docstring and removed lines 1068-1071
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.