Skip to content

Commit 9a4c9f2

Browse files
committed
MAINT add docstring to explain the motivation of the fixture
1 parent ac45e5d commit 9a4c9f2

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/tutorial/text_analytics/working_with_text_data_fixture.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
"""Fixture module to skip the datasets loading when offline
2+
3+
The 20 newsgroups data is rather large and some CI workers such as travis are
4+
stateless hence will not cache the dataset as regular sklearn users would do.
5+
6+
The following will skip the execution of the working_with_text_data.rst doctests
7+
is the proper environment variable is configured (see the source code of
8+
check_skip_network for more details).
9+
10+
"""
111
from sklearn.utils.testing import check_skip_network
212

313

0 commit comments

Comments
 (0)