Skip to content

DOC: Clarified documentation for convert_dates and use_default_dates params #30949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 14, 2020
Merged

DOC: Clarified documentation for convert_dates and use_default_dates params #30949

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d8eb8d
DOC: Clarified documentation for convert_dates and use_default_dates …
amilbourne Jan 12, 2020
32ae938
Reworded after feedback from WillAyd
amilbourne Jan 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions pandas/io/json/_json.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,8 +439,17 @@ def read_json(
Not applicable for ``orient='table'``.

convert_dates : bool or list of str, default True
List of columns to parse for dates. If True, then try to parse
datelike columns. A column label is datelike if
If True then default datelike columns may be converted (depending on
keep_default_dates).
If False, no dates will be converted.
If a list of column names, then those columns will be converted and
default datelike columns may also be converted (depending on
keep_default_dates).

keep_default_dates : bool, default True
If parsing dates (convert_dates is not False), then try to parse the
default datelike columns.
A column label is datelike if

* it ends with ``'_at'``,

Expand All @@ -452,9 +461,6 @@ def read_json(

* it is ``'date'``.

keep_default_dates : bool, default True
If parsing dates, then parse the default datelike columns.

numpy : bool, default False
Direct decoding to numpy arrays. Supports numeric data only, but
non-numeric column and index labels are supported. Note also that the
Expand Down