Skip to content

Commit 8b39347

Browse files
gfyoungTomAugspurger
authored andcommitted
DOC: Fixtures docs in io/parser/conftest.py (#30775)
Partially addresses: #19159
1 parent b5da1ae commit 8b39347

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

pandas/tests/io/parser/conftest.py

+15
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,17 @@ class PythonParser(BaseParser):
4646

4747
@pytest.fixture
4848
def csv_dir_path(datapath):
49+
"""
50+
The directory path to the data files needed for parser tests.
51+
"""
4952
return datapath("io", "parser", "data")
5053

5154

5255
@pytest.fixture
5356
def csv1(csv_dir_path):
57+
"""
58+
The path to the data file "test1.csv" needed for parser tests.
59+
"""
5460
return os.path.join(csv_dir_path, "test1.csv")
5561

5662

@@ -69,14 +75,23 @@ def csv1(csv_dir_path):
6975

7076
@pytest.fixture(params=_all_parsers, ids=_all_parser_ids)
7177
def all_parsers(request):
78+
"""
79+
Fixture all of the CSV parsers.
80+
"""
7281
return request.param
7382

7483

7584
@pytest.fixture(params=_c_parsers_only, ids=_c_parser_ids)
7685
def c_parser_only(request):
86+
"""
87+
Fixture all of the CSV parsers using the C engine.
88+
"""
7789
return request.param
7890

7991

8092
@pytest.fixture(params=_py_parsers_only, ids=_py_parser_ids)
8193
def python_parser_only(request):
94+
"""
95+
Fixture all of the CSV parsers using the Python engine.
96+
"""
8297
return request.param

0 commit comments

Comments
 (0)