DOC: Added deprecation to convert_objects docstring#12052 #12209
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
| @@ -2724,6 +2724,9 @@ def _convert(self, datetime=False, numeric=False, timedelta=False, | |||
| def convert_objects(self, convert_dates=True, convert_numeric=False, | |||
| convert_timedeltas=True, copy=True): | |||
| """ | |||
| Deprecated. Use the data-type specific converters pd.to_datetime, | |||
| pd.to_timedelta, and pd.to_numeric. | |||
|
|
|||
There was a problem hiding this comment.
Add this instead to the See Also section (leave the deprecated part)
| See also | ||
| -------- | ||
| pandas.to_datetime | ||
| Convert argument to datetime. |
There was a problem hiding this comment.
Following https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#sections, the format for the see also is like
pandas.to_datetime : Convert argument to datetime
|
thanks! |
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.
Added deprecation warning to convert_objects docstring
Closes #12052