Skip to content

DOC: include defaults into docs for true_values and false_values #48597

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
Sep 23, 2022
Merged

DOC: include defaults into docs for true_values and false_values #48597

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb684d2
DOC: include defaults into docs for true_values and false_values
AlexKirko Sep 17, 2022
9e8c08a
Merge branch 'main' into expand-read-csv-docs
AlexKirko Sep 19, 2022
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
4 changes: 2 additions & 2 deletions pandas/io/parsers/readers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,9 +195,9 @@
Dict of functions for converting values in certain columns. Keys can either
be integers or column labels.
true_values : list, optional
Values to consider as True.
Values to consider as True in addition to case-insensitive variants of "True".
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you know if there are tests for case-insensitive variants of True/False?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a great question, it will tell us whether the case insensitivity is intended or unnoticed behavior. I'll take a look today or tomorrow.

Copy link
Member Author

@AlexKirko AlexKirko Sep 23, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mroeschke I've taken a look, and the closest that I can find is test_boolean_dtype here. There are also some conversion tests in test_na_values.py. But those have a different purpose.

What would your suggestion be?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for checking. I think test_boolean_dtype should cover the additional docstring note you added here.

false_values : list, optional
Values to consider as False.
Values to consider as False in addition to case-insensitive variants of "False".
skipinitialspace : bool, default False
Skip spaces after delimiter.
skiprows : list-like, int or callable, optional
Expand Down