Skip to content

Commit aa81e2a

Browse files
Merge pull request #9830 from evanpw/convert_docs
DOC: Clean up documentation for convert_objects
2 parents 52a30d9 + 2305eaf commit aa81e2a

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

pandas/core/generic.py

+14-10
Original file line numberDiff line numberDiff line change
@@ -2261,19 +2261,23 @@ def convert_objects(self, convert_dates=True, convert_numeric=False,
22612261
22622262
Parameters
22632263
----------
2264-
convert_dates : if True, attempt to soft convert dates, if 'coerce',
2265-
force conversion (and non-convertibles get NaT)
2266-
convert_numeric : if True attempt to coerce to numbers (including
2267-
strings), non-convertibles get NaN
2268-
convert_timedeltas : if True, attempt to soft convert timedeltas, if 'coerce',
2269-
force conversion (and non-convertibles get NaT)
2270-
copy : Boolean, if True, return copy even if no copy is necessary
2271-
(e.g. no conversion was done), default is True.
2272-
It is meant for internal use, not to be confused with `inplace` kw.
2264+
convert_dates : boolean, default True
2265+
If True, convert to date where possible. If 'coerce', force
2266+
conversion, with unconvertible values becoming NaT.
2267+
convert_numeric : boolean, default False
2268+
If True, attempt to coerce to numbers (including strings), with
2269+
unconvertible values becoming NaN.
2270+
convert_timedeltas : boolean, default True
2271+
If True, convert to timedelta where possible. If 'coerce', force
2272+
conversion, with unconvertible values becoming NaT.
2273+
copy : boolean, default True
2274+
If True, return a copy even if no copy is necessary (e.g. no
2275+
conversion was done). Note: This is meant for internal use, and
2276+
should not be confused with inplace.
22732277
22742278
Returns
22752279
-------
2276-
converted : asm as input object
2280+
converted : same as input object
22772281
"""
22782282
return self._constructor(
22792283
self._data.convert(convert_dates=convert_dates,

0 commit comments

Comments
 (0)