apache / apache/arrow

[Python][Doc] Documentation for Test Groups out of sync

Open
#33,267 1 comment 0 reactions 0 assignees View on GitHub
Component: Python Type: bug
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 13h
Merged PRs (30d)
88

Description

In the Python documentation for [Test Groups](https://arrow.apache.org/docs/dev/developers/python.html#test-groups) it's stated:
> We have many tests that are grouped together using pytest marks. Some of these are disabled by default. To enable a test group, pass --$GROUP_NAME, e.g. --parquet. [continues]
However, I get:

`$ pytest --parquet # from arrow/python dir`
`ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]`
`pytest: error: unrecognized arguments: --parquet`

 

Am I interpreting the docs wrong or has something changed since writing the docs?

 

Related: `pytest --markers` only reports the full list of pytest Marks when I'm in the `arrow/python/pyarrow` directory but not `arrow/python`. When I'm in the `arrow/python/pyarrow` subdirectory, marks work as expected (ie `pytest -m parquet works`).

**Reporter**: [Bryce Mecum](https://issues.apache.org/jira/browse/ARROW-18066) / @amoeba

**Note**: *This issue was originally created as [ARROW-18066](https://issues.apache.org/jira/browse/ARROW-18066). Please see the [migration documentation](https://github.com/apache/arrow/issues/14542) for further details.*

Contributor guide

Open the contributing guide

Research direction

Start with the Python documentation's Test Groups section and reproduce the documented pytest --parquet command from arrow/python, then compare it with pytest --markers and pytest -m parquet from arrow/python/pyarrow. Done means the documentation accurately describes the working command, directory, and marker behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, testing
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.