Document pytest-xdist conflict

openforcefield · Mar 4, 2025 · 016e6b3 · 016e6b3
1 parent f1a2bf5
commit 016e6b3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -71,6 +71,7 @@ jobs:
           PYTEST_ARGS+=" --ignore=openff/units/_tests/test_openmm.py"
         fi
 
+        # https://github.com/openforcefield/openff-units/issues/111
         python -c "from openff.units import *"
         python -m pytest $PYTEST_ARGS $COV openff/units/_tests/
 

diff --git a/README.md b/README.md
@@ -133,6 +133,10 @@ Quantity(value=4.0, unit=angstrom)  # OpenMM
 <Quantity(4.0, 'angstrom')>  # OpenFF
 ```
 
+### Known issues
+
+There is a quirk with cached unit registry definitions that can cause issues when running tests in parallel (i.e. with `pytest-xdist`). See [Issue #111](https://github.com/openforcefield/openff-units/issues/111) for more details.
+
 ### Copyright
 
 Copyright (c) 2021, Open Force Field Initiative