Skip to content

Commit cb05c13

Browse files
amilbourneWillAyd
authored andcommitted
DOC: Clarified documentation for convert_dates and use_default_dates params (#30949)
1 parent 3787133 commit cb05c13

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

pandas/io/json/_json.py

+11-5
Original file line numberDiff line numberDiff line change
@@ -439,8 +439,17 @@ def read_json(
439439
Not applicable for ``orient='table'``.
440440
441441
convert_dates : bool or list of str, default True
442-
List of columns to parse for dates. If True, then try to parse
443-
datelike columns. A column label is datelike if
442+
If True then default datelike columns may be converted (depending on
443+
keep_default_dates).
444+
If False, no dates will be converted.
445+
If a list of column names, then those columns will be converted and
446+
default datelike columns may also be converted (depending on
447+
keep_default_dates).
448+
449+
keep_default_dates : bool, default True
450+
If parsing dates (convert_dates is not False), then try to parse the
451+
default datelike columns.
452+
A column label is datelike if
444453
445454
* it ends with ``'_at'``,
446455
@@ -452,9 +461,6 @@ def read_json(
452461
453462
* it is ``'date'``.
454463
455-
keep_default_dates : bool, default True
456-
If parsing dates, then parse the default datelike columns.
457-
458464
numpy : bool, default False
459465
Direct decoding to numpy arrays. Supports numeric data only, but
460466
non-numeric column and index labels are supported. Note also that the

0 commit comments

Comments
 (0)