Skip to content

Commit e8ef4f8

Browse files
MattRijkjreback
authored andcommitted
DOC: Added deprecation to convert_objects docstring#12052
Added deprecation warning to convert_objects docstring Closes pandas-dev#12052 Author: MattRijk <[email protected]> Closes pandas-dev#12209 from MattRijk/doc-12052 and squashes the following commits: 5be5d7a [MattRijk] Changed See also to correct format 8ff0da0 [MattRijk] Added See also section to convert_objects docs. a10997d [MattRijk] DOC: Added deprecation to convert_objects docstring#12052
1 parent 45a83a0 commit e8ef4f8

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

pandas/core/generic.py

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2034,7 +2034,7 @@ def _reindex_multi(self, axes, copy, fill_value):
20342034
--------
20352035
>>> df.reindex_axis(['A', 'B', 'C'], axis=1)
20362036
2037-
See also
2037+
See Also
20382038
--------
20392039
reindex, reindex_like
20402040
@@ -2740,6 +2740,8 @@ def _convert(self, datetime=False, numeric=False, timedelta=False,
27402740
def convert_objects(self, convert_dates=True, convert_numeric=False,
27412741
convert_timedeltas=True, copy=True):
27422742
"""
2743+
Deprecated.
2744+
27432745
Attempt to infer better dtype for object columns
27442746
27452747
Parameters
@@ -2758,6 +2760,13 @@ def convert_objects(self, convert_dates=True, convert_numeric=False,
27582760
conversion was done). Note: This is meant for internal use, and
27592761
should not be confused with inplace.
27602762
2763+
See Also
2764+
--------
2765+
pandas.to_datetime : Convert argument to datetime.
2766+
pandas.to_timedelta : Convert argument to timedelta.
2767+
pandas.to_numeric : Return a fixed frequency timedelta index,
2768+
with day as the default.
2769+
27612770
Returns
27622771
-------
27632772
converted : same as input object
@@ -2808,7 +2817,7 @@ def convert_objects(self, convert_dates=True, convert_numeric=False,
28082817
or the string 'infer' which will try to downcast to an appropriate
28092818
equal type (e.g. float64 to int64 if possible)
28102819
2811-
See also
2820+
See Also
28122821
--------
28132822
reindex, asfreq
28142823
@@ -2988,7 +2997,7 @@ def replace(self, to_replace=None, value=None, inplace=False, limit=None,
29882997
The method to use when for replacement, when ``to_replace`` is a
29892998
``list``.
29902999
2991-
See also
3000+
See Also
29923001
--------
29933002
NDFrame.reindex
29943003
NDFrame.asfreq
@@ -3299,7 +3308,7 @@ def isnull(self):
32993308
"""
33003309
Return a boolean same-sized object indicating if the values are null.
33013310
3302-
See also
3311+
See Also
33033312
--------
33043313
notnull : boolean inverse of isnull
33053314
"""
@@ -3309,7 +3318,7 @@ def notnull(self):
33093318
"""Return a boolean same-sized object indicating if the values are
33103319
not null.
33113320
3312-
See also
3321+
See Also
33133322
--------
33143323
isnull : boolean inverse of notnull
33153324
"""
@@ -3387,7 +3396,7 @@ def clip_upper(self, threshold, axis=None):
33873396
axis : int or string axis name, optional
33883397
Align object with threshold along the given axis.
33893398
3390-
See also
3399+
See Also
33913400
--------
33923401
clip
33933402
@@ -3411,7 +3420,7 @@ def clip_lower(self, threshold, axis=None):
34113420
axis : int or string axis name, optional
34123421
Align object with threshold along the given axis.
34133422
3414-
See also
3423+
See Also
34153424
--------
34163425
clip
34173426
@@ -4571,7 +4580,7 @@ def abs(self):
45714580
45724581
The include, exclude arguments are ignored for Series.
45734582
4574-
See also
4583+
See Also
45754584
--------
45764585
DataFrame.select_dtypes
45774586
"""

0 commit comments

Comments
 (0)