Skip to content

DOC: Added deprecation to convert_objects docstring#12052 #12209

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

Closed
wants to merge 3 commits into from
Closed

DOC: Added deprecation to convert_objects docstring#12052 #12209

wants to merge 3 commits into from

Conversation

MattRijk
Copy link
Contributor

@MattRijk MattRijk commented Feb 2, 2016

Added deprecation warning to convert_objects docstring
Closes #12052

@@ -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.

Copy link
Contributor

Choose a reason for hiding this comment

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

Add this instead to the See Also section (leave the deprecated part)

See also
--------
pandas.to_datetime
Convert argument to datetime.
Copy link
Member

Choose a reason for hiding this comment

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

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

@jreback jreback added Docs Deprecate Functionality to remove in pandas labels Feb 5, 2016
@jreback jreback added this to the 0.18.0 milestone Feb 5, 2016
@jreback jreback closed this in e8ef4f8 Feb 6, 2016
@jreback
Copy link
Contributor

jreback commented Feb 6, 2016

thanks!

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

Successfully merging this pull request may close these issues.

3 participants