Skip to content

Commit 0b2b6b0

Browse files
committed
docs(readme): correct layout and add instructions for single test
1 parent 5affc17 commit 0b2b6b0

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14622466.svg)](https://doi.org/10.5281/zenodo.14622466)
88
[![Tests](https://github.com/pythonhealthdatascience/rap_template_python_des/actions/workflows/tests.yaml/badge.svg)](https://github.com/pythonhealthdatascience/rap_template_python_des/actions/workflows/tests.yaml)
99

10-
<br>A template for creating **discrete-event simulation (DES)** models in Python<br>
11-
within a **reproducible analytical pipeline (RAP)**. <br><br>
10+
<br>A template for creating **discrete-event simulation (DES)** models in Python within a **reproducible analytical pipeline (RAP)**. <br><br>
1211
Click on <kbd>Use this template</kbd> to initialise new repository.<br>
1312
A `README` template is provided at the **end of this file**.
1413

@@ -156,6 +155,12 @@ To run tests in parallel -
156155
pytest -n auto
157156
```
158157

158+
To run a specific test:
159+
160+
```
161+
pytest tests/testfile.py -k 'testname'
162+
```
163+
159164
The repository contains a GitHub action `tests.yaml` which will automatically run tests with new commits to GitHub. This is continuous integration, helping to catch bugs early and keep the code stable. It will run the tests on three operating systems: Ubuntu, Windows and Mac.
160165

161166
If you have changed the model behaviour, you may wish to amend, remove or write new tests.

0 commit comments

Comments
 (0)