Skip to content

Commit 71466b6

Browse files
author
Shashwat
committed
docs: showed warning
1 parent 20cda25 commit 71466b6

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

doc/source/user_guide/io.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,12 @@ parse_dates : boolean or list of ints or names or list of lists or dict, default
272272

273273
.. note::
274274
A fast-path exists for iso8601-formatted dates.
275+
276+
.. note::
277+
The ``infer_datetime_format`` is deprecated and will be removed in the future versions.
278+
infer_datetime_format : boolean, default ``False``
279+
If ``True`` and parse_dates is enabled for a column, attempt to infer the
280+
datetime format to speed up the processing.(this is deprecated and will be removed in a future version)
275281
keep_date_col : boolean, default ``False``
276282
If ``True`` and parse_dates specifies combining multiple columns then keep the
277283
original columns.
@@ -913,11 +919,12 @@ an exception is raised, the next one is tried:
913919

914920
Note that performance-wise, you should try these methods of parsing dates in order:
915921

922+
1. Try to infer the format using ``infer_datetime_format=True`` (this is deprecated and will be removed in the future versions.).
916923

917-
1. If you know the format, use ``pd.to_datetime()``:
924+
2. If you know the format, use ``pd.to_datetime()``:
918925
``date_parser=lambda x: pd.to_datetime(x, format=...)``.
919926

920-
2. If you have a really non-standard format, use a custom ``date_parser`` function.
927+
3. If you have a really non-standard format, use a custom ``date_parser`` function.
921928
For optimal performance, this should be vectorized, i.e., it should accept arrays
922929
as arguments.
923930

@@ -1647,6 +1654,7 @@ Options that are unsupported by the pyarrow engine which are not covered by the
16471654
* ``decimal``
16481655
* ``iterator``
16491656
* ``dayfirst``
1657+
* ``infer_datetime_format``
16501658
* ``verbose``
16511659
* ``skipinitialspace``
16521660
* ``low_memory``
@@ -6378,4 +6386,4 @@ The files ``test.pkl.compress``, ``test.parquet`` and ``test.feather`` took the
63786386
24009288 Oct 10 06:43 test_fixed.hdf
63796387
24009288 Oct 10 06:43 test_fixed_compress.hdf
63806388
24458940 Oct 10 06:44 test_table.hdf
6381-
24458940 Oct 10 06:44 test_table_compress.hdf
6389+
24458940 Oct 10 06:44 test_table_compress.hdf

0 commit comments

Comments
 (0)