Skip to content

DOC: Minor fixes in pandas/testing.py docstring. #28752

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
Oct 4, 2019
Merged

DOC: Minor fixes in pandas/testing.py docstring. #28752

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
454216e
Minor fixes in pandas/testing.py docstring
anirudnits Oct 2, 2019
8709a26
Made the required changes
anirudnits Oct 3, 2019
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
8 changes: 4 additions & 4 deletions pandas/util/testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ def assert_index_equal(
----------
left : Index
right : Index
exact : bool / string {'equiv'}, default 'equiv'
exact : bool / str {'equiv'}, default 'equiv'
Copy link
Member

@datapythonista datapythonista Oct 2, 2019

Choose a reason for hiding this comment

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

I'd prefer bool or {'equiv'}, what do you think? (in all cases)

Copy link
Contributor Author

@anirudnits anirudnits Oct 3, 2019

Choose a reason for hiding this comment

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

@datapythonista yeah we could do that. I will make the required changes and resubmit it then

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 @@ -1089,7 +1089,7 @@ def assert_series_equal(
right : Series
check_dtype : bool, default True
Whether to check the Series dtype is identical.
check_index_type : bool / string {'equiv'}, default 'equiv'
check_index_type : bool / str {'equiv'}, default 'equiv'
Whether to check the Index class, dtype and inferred_type
are identical.
check_series_type : bool, default True
Expand Down Expand Up @@ -1251,10 +1251,10 @@ def assert_frame_equal(
Second DataFrame to compare.
check_dtype : bool, default True
Whether to check the DataFrame dtype is identical.
check_index_type : bool / string {'equiv'}, default 'equiv'
check_index_type : bool / str {'equiv'}, default 'equiv'
Whether to check the Index class, dtype and inferred_type
are identical.
check_column_type : bool / string {'equiv'}, default 'equiv'
check_column_type : bool / str {'equiv'}, default 'equiv'
Whether to check the columns class, dtype and inferred_type
are identical. Is passed as the ``exact`` argument of
:func:`assert_index_equal`.
Expand Down