Add documentation of the different tox environments #228
Conversation
This file is adapted from the quantum-prototype-template.
Pull Request Test Coverage Report for Build 5146466846
💛 - Coveralls |
|
|
||
| ## Coverage environment | ||
|
|
||
| The `coverage` environment uses [Coverage.py] to ensure that the fraction of code tested by pytest is above some threshold (currently set to 80% overall, and 100% in all new modules). A detailed, line-by-line coverage report can be viewed by navigating to `htmlcov/index.html` in a web browser. |
There was a problem hiding this comment.
I notice Coverage.py and Jupyter are capitalized in the brackets, but many other packages are not. Also [Black] has the underscores. Are there any principles to capitalization for these packages?
Capitalization aside, do we want to include the file extension for coverage? We don't do that elsewhere here
There was a problem hiding this comment.
I followed the way each package's name is formatted in its own documentation. For instance, https://coverage.readthedocs.io/en/7.2.7/ says "Coverage.py", presumably to disambiguate from other coverage tools. And https://tox.wiki/en/latest/ is without capitalization.
There was a problem hiding this comment.
OK cool, I figured you followed some principle. Looks great, thanks
This file is adapted from the quantum-prototype-template.
I am also working on a "developer guide" for the Sphinx docs, which will link to this and a few other files.
Preview at https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/blob/tox-readme/test/README.md