Skip to content

DOC: Fix outdated default values in util.testing docstrings #22776

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 3 commits into from
Sep 20, 2018
Merged

DOC: Fix outdated default values in util.testing docstrings #22776

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f56bb35
Fix outdated docstrings in util/testing.py
Aug 28, 2018
99210d1
Fix escape sequence issue in docstring
Sep 20, 2018
4fed465
Update testing.py
jorisvandenbossche Sep 20, 2018
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
13 changes: 7 additions & 6 deletions pandas/util/testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ def assert_almost_equal(left, right, check_dtype="equiv",
----------
left : object
right : object
check_dtype : bool / string {'equiv'}, default False
check_dtype : bool / string {'equiv'}, default 'equiv'
Check dtype if both a and b are the same type. If 'equiv' is passed in,
then `RangeIndex` and `Int64Index` are also considered equivalent
when doing type checking.
Expand Down Expand Up @@ -787,7 +787,7 @@ def assert_index_equal(left, right, exact='equiv', check_names=True,
----------
left : Index
right : Index
exact : bool / string {'equiv'}, default False
exact : bool / string {'equiv'}, default 'equiv'
Whether to check the Index class, dtype and inferred_type
are identical. If 'equiv', then RangeIndex can be substituted for
Int64Index as well.
Expand Down Expand Up @@ -1034,7 +1034,7 @@ def assert_interval_array_equal(left, right, exact='equiv',
Whether to check the Index class, dtype and inferred_type
are identical. If 'equiv', then RangeIndex can be substituted for
Int64Index as well.
obj : str, default 'Categorical'
obj : str, default 'IntervalArray'
Specify object name being compared, internally used to show appropriate
assertion message
"""
Expand Down Expand Up @@ -1326,12 +1326,13 @@ def assert_frame_equal(left, right, check_dtype=True,
Second DataFrame to compare.
check_dtype : bool, default True
Whether to check the DataFrame dtype is identical.
check_index_type : {'equiv'} or bool, default 'equiv'
check_index_type : bool / string {'equiv'}, default 'equiv'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this and everything below it in this diff is from a botched rebase. Trying to fix it...

Whether to check the Index class, dtype and inferred_type
are identical.
check_column_type : {'equiv'} or bool, default 'equiv'
check_column_type : bool / string {'equiv'}, default 'equiv'
Whether to check the columns class, dtype and inferred_type
are identical.
are identical. Is passed as the ``exact`` argument of
:func:`assert_index_equal`.
check_frame_type : bool, default True
Whether to check the DataFrame class is identical.
check_less_precise : bool or int, default False
Expand Down