Skip to content

Commit b58cc06

Browse files
committed
Add note about SharedWithSparse._assert_series_equal()
1 parent 0a7a362 commit b58cc06

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

pandas/tests/series/test_api.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,12 @@
2121

2222

2323
class SharedWithSparse(object):
24+
"""
25+
A collection of tests Series and SparseSeries can share.
2426
27+
In generic tests on this class, use ``self._assert_series_equal()``
28+
which is implemented in sub-classes.
29+
"""
2530
def _assert_series_equal(self, left, right):
2631
"""Dispatch to series class dependent assertion"""
2732
raise NotImplementedError
@@ -194,6 +199,7 @@ def test_constructor_dict_timedelta_index(self):
194199
class TestSeriesMisc(TestData, SharedWithSparse):
195200

196201
series_klass = Series
202+
# SharedWithSparse tests use generic, series_klass-agnostic assertion
197203
_assert_series_equal = staticmethod(tm.assert_series_equal)
198204

199205
def test_tab_completion(self):

pandas/tests/sparse/test_series.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ def _test_data2_zero():
6161
class TestSparseSeries(SharedWithSparse):
6262

6363
series_klass = SparseSeries
64+
# SharedWithSparse tests use generic, series_klass-agnostic assertion
6465
_assert_series_equal = staticmethod(tm.assert_sp_series_equal)
6566

6667
def setup_method(self, method):

0 commit comments

Comments
 (0)