Skip to content

Commit f66fdb1

Browse files
darguetavictor
authored and
victor
committed
DOC: Fix outdated default values in util.testing docstrings (pandas-dev#22776)
1 parent 4f44f84 commit f66fdb1

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

pandas/util/testing.py

+7-6
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ def assert_almost_equal(left, right, check_dtype="equiv",
225225
----------
226226
left : object
227227
right : object
228-
check_dtype : bool / string {'equiv'}, default False
228+
check_dtype : bool / string {'equiv'}, default 'equiv'
229229
Check dtype if both a and b are the same type. If 'equiv' is passed in,
230230
then `RangeIndex` and `Int64Index` are also considered equivalent
231231
when doing type checking.
@@ -787,7 +787,7 @@ def assert_index_equal(left, right, exact='equiv', check_names=True,
787787
----------
788788
left : Index
789789
right : Index
790-
exact : bool / string {'equiv'}, default False
790+
exact : bool / string {'equiv'}, default 'equiv'
791791
Whether to check the Index class, dtype and inferred_type
792792
are identical. If 'equiv', then RangeIndex can be substituted for
793793
Int64Index as well.
@@ -1034,7 +1034,7 @@ def assert_interval_array_equal(left, right, exact='equiv',
10341034
Whether to check the Index class, dtype and inferred_type
10351035
are identical. If 'equiv', then RangeIndex can be substituted for
10361036
Int64Index as well.
1037-
obj : str, default 'Categorical'
1037+
obj : str, default 'IntervalArray'
10381038
Specify object name being compared, internally used to show appropriate
10391039
assertion message
10401040
"""
@@ -1326,12 +1326,13 @@ def assert_frame_equal(left, right, check_dtype=True,
13261326
Second DataFrame to compare.
13271327
check_dtype : bool, default True
13281328
Whether to check the DataFrame dtype is identical.
1329-
check_index_type : {'equiv'} or bool, default 'equiv'
1329+
check_index_type : bool / string {'equiv'}, default 'equiv'
13301330
Whether to check the Index class, dtype and inferred_type
13311331
are identical.
1332-
check_column_type : {'equiv'} or bool, default 'equiv'
1332+
check_column_type : bool / string {'equiv'}, default 'equiv'
13331333
Whether to check the columns class, dtype and inferred_type
1334-
are identical.
1334+
are identical. Is passed as the ``exact`` argument of
1335+
:func:`assert_index_equal`.
13351336
check_frame_type : bool, default True
13361337
Whether to check the DataFrame class is identical.
13371338
check_less_precise : bool or int, default False

0 commit comments

Comments
 (0)