File tree Expand file tree Collapse file tree 1 file changed +17
-3
lines changed
Expand file tree Collapse file tree 1 file changed +17
-3
lines changed Original file line number Diff line number Diff line change @@ -21,12 +21,26 @@ Ensure to rebase your branch to include the latest changes on your branch and re
2121
2222Unit-testing and coverage
2323-------------------------
24- Python-RAT will use the ** unittest** module for testing. Proper documentation and unit tests is highly recommended.
24+ Python-RAT uses the ** pytest** module for testing. Proper documentation and unit tests are highly recommended.
25+
26+ To install pytest use
27+
28+ pip install pytest pytest-cov
29+
30+ Run the tests and generate a coverage report with
31+
32+ pytest tests --cov=RAT
33+
34+ The coverage report can be saved to the directory htmlcov by running the tests with
35+
36+ pytest tests --cov-report html --cov=RAT
37+
38+ For information on other coverage report formats, see https://pytest-cov.readthedocs.io/en/latest/reporting.html
2539
2640Documentation
2741-------------
28- The documentation will be hosted on GitHub pages
42+ The documentation will be hosted on GitHub pages.
2943
3044Style guidelines
3145----------------
32- * Docstrings should be written in the reStructuredText format.
46+ * Docstrings should be written in the numpydoc format.
You can’t perform that action at this time.
0 commit comments