DOC: Remove old note about default unit #46103
Merged
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
This reverts commit 438bb21.
phofl
reviewed
Feb 21, 2022
| @@ -765,8 +765,8 @@ def to_datetime( | |||
| unit : str, default 'ns' | |||
| The unit of the arg (D,s,ms,us,ns) denote the unit, which is an | |||
| integer or float number. This will be based off the origin. | |||
| Example, with ``unit='ms'`` and ``origin='unix'`` (the default), this | |||
There was a problem hiding this comment.
I am pretty sure this is only referencing origin and not unit
There was a problem hiding this comment.
Yeah, it could be interpreted either way. I suggest that it's at least potentially confusing and a maintenance risk, so we'd be better off without it.
There was a problem hiding this comment.
could change the order to put the "origin=unix (the default)" before "unit=ms"
There was a problem hiding this comment.
Indeed, but I suggest that documenting what value is the default in multiple places is asking for trouble in the long run.
mroeschke
approved these changes
Feb 22, 2022
|
thanks @gsganden |
yehoshuadimarsky
pushed a commit
to yehoshuadimarsky/pandas
that referenced
this pull request
Jul 13, 2022
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.
to_datetimedocstring indicates that the default unit is 'ms', but it is 'ns'. This PR simply removes that comment so that there is no need to keep it in sync with the implementation.closes #xxxx (Replace xxxx with the Github issue number)NATests added and passed if fixing a bug or adding a new featureNAAdded an entry in the latestNAdoc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.