Skip to content

Commit 2305eaf

Browse files
committed
DOC: Clean up documentation for convert_objects
1 parent 0222024 commit 2305eaf

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

0 commit comments

Comments
 (0)