Skip to content

Commit 971254c

Browse files
committed
Minor tweaks to exercise
1 parent 3ccf333 commit 971254c

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

05_testing_and_ci/python_testing_exercise.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,14 @@
99

1010
- An operating system / software / environment where you can install Python and some basic Python tools
1111
- An editor or IDE to edit Python code and write text files
12-
- The following Python tools:
13-
- Python (version >= 3)
14-
- [pip](https://pypi.org/project/pip/)
15-
- [NumPy](https://numpy.org/)
16-
- [Matplotlib](https://matplotlib.org/)
17-
- [pytest](https://docs.pytest.org/en/6.2.x/getting-started.html#install-pytest)
18-
- [unittest](https://docs.python.org/3/library/unittest.html#module-unittest)
19-
- [coverage](https://coverage.readthedocs.io/en/6.2/#quick-start)
20-
- [tox](https://tox.wiki/en/4.23.2/installation.html)
12+
- Python (version >= 3)
13+
- [pip](https://pypi.org/project/pip/)
14+
- [NumPy](https://numpy.org/)
15+
- [Matplotlib](https://matplotlib.org/)
16+
- [pytest](https://docs.pytest.org/en/6.2.x/getting-started.html#install-pytest)
17+
- [unittest](https://docs.python.org/3/library/unittest.html#module-unittest)
18+
- [coverage](https://coverage.readthedocs.io/en/6.2/#quick-start)
19+
- [tox](https://tox.wiki/en/4.23.2/installation.html)
2120

2221
## Step 1 - Getting Familiar With the Code
2322

@@ -98,7 +97,7 @@ pytest tests/unit/test_diffusion2d_functions.py
9897

9998
- Using the coverage tool generate a HTML report of the code coverage of all the tests.
10099
- Open the report file in a browser and print the report to a file called `coverage-report.pdf`. Add this file to the repository.
101-
- **Note**: coverage can be used with both `pytest` and `unittest`. In this case generating the report of the unit tests using unittest is sufficient.
100+
- **Note**: coverage can be used with both `pytest` and `unittest`. In this case, generating the report of the unit tests using unittest is sufficient.
102101

103102
## Step 7 - Automation Using tox
104103

@@ -107,4 +106,4 @@ pytest tests/unit/test_diffusion2d_functions.py
107106

108107
## Step 8 - Submission
109108

110-
- Open a pull request titled `[your GitLab username] Adding tests` from your fork to the main repository.
109+
- Open a pull request titled `[<your GitLab username>] Adding tests` (for example: `[desaiin] Adding tests`) from your fork to the main branch of the exercise repository.

0 commit comments

Comments
 (0)