🎨 format README.md

Author: enryH

tests/README.md

@@ -12,13 +12,17 @@ backgroundColor: #fff
 ## Quick start
 
 ### Installation
+
 Install pytest. e.g., from the "dev" dependencies
+
 ```bash
 pip install ".[dev]"
 ```
 
 ### How to use
+
 To execute the tests run e.g.
+
 ```bash
 pytest
 ```
@@ -30,43 +34,46 @@ pytest
 ---
 
 ### Folder and test naming
+
 1. The tests for functions in `<filename>.py` should go in `tests/test_<filename>.py`
-    
-    e.g., the tests for [python_package/mockup.py](../src/python_package/mockup.py) are in [tests/test_mockup.py](test_mockup.py)
 
-2. The test names should start with `def test_<corresponding_function_name> ...` 
+   e.g., the tests for [python_package/mockup.py](../src/python_package/mockup.py) are in [tests/test_mockup.py](test_mockup.py)
+
+2. The test names should start with `def test_<corresponding_function_name> ...`
 
-    e.g., `def test_hello_world(): ...`
+   e.g., `def test_hello_world(): ...`
 
 ---
 
 ### Some Pytest decorators
 
 1. To indicate that the test function is expected to fail you can prepend
-    ```python
-    @pytest.mark.xfail(raises=TypeError)
-    def test_hello_world_str(): ...
-    ```
+
+   ```python
+   @pytest.mark.xfail(raises=TypeError)
+   def test_hello_world_str(): ...
+   ```
 
 ---
 
 2. To setup and cleanup any resources for a test you can use [pytest fixtures with `yield`](https://dev.to/dawidbeno/understanding-yield-in-pytest-fixtures-4m38)
 
-    ```python
-    @pytest.fixture
-    def temp_file():
-        # set up
-        < code to create a file>
-        # return
-        yield
-            the_file
-        # clean up
-        < code to remove the file>
-    ```
+   ```python
+   @pytest.fixture
+   def temp_file():
+       # set up
+       < code to create a file>
+       # return
+       yield
+           the_file
+       # clean up
+       < code to remove the file>
+   ```
 
 ---
 
 ### Doctests
+
 You can also include tests in your docstrings using `>>>` followed by the expected result e.g.
 
 ```python
@@ -82,7 +89,8 @@ def hello_world(n):
         ...
     """
 ```
-*Needs `addopts = --doctest-modules` in pytest.ini
+
+Needs `addopts = --doctest-modules` in `pytest.ini` in root of directory
 
 ---
 
@@ -102,6 +110,3 @@ def saved_world(filename):
         ...
     """
 ```
-
-
-