search

aragilar / pytest-mpi

Pytest plugin for working with MPI
https://pytest-mpi.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
19 stars 7 forks source link

Inconsistent MPI marker docs/enums #34

Open Helveg opened 3 years ago

Helveg commented 3 years ago

The MPIMarkerEnum class lists 4 markers: mpi, mpi_skip, mpi_xfail and mpi_break; the MPI_MARKERS constant right below lists only 3 of them (misses mpi) and the marker docs don't mention mpi_break.

https://github.com/aragilar/pytest-mpi/blob/9ad369af744a47cedf5025245f051e793703c748/src/pytest_mpi/__init__.py#L19-L39

aragilar commented 3 years ago

The missing documentation is accidental, that should be fixed.

The MPI_MARKERS constant is correct—it's mapping the intent of the marker when being run under MPI to the appropriate pytest mark (as the mpi marker need do nothing when run under MPI, rather the inverse is true).