From 3dbb2dc6d27e9623c71b40b8237fa15e5747e5e2 Mon Sep 17 00:00:00 2001
From: Declan <5962877+dec1@users.noreply.github.com>
Date: Thu, 20 Jun 2024 19:33:54 +0200
Subject: [PATCH] add comments to ci

---
 .github/workflows/ci.yaml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index 0d670d0..02338c0 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -22,11 +22,13 @@ jobs:
     - name: Check out the repository
       uses: actions/checkout@v4
 
+  # ---- Set up Python  -------------------
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
         python-version: ${{ env.PYTHON_VERSION }}
 
+  # ---- Set up dependencies -------------------
     - name: Set up dependencies (Linux)
       if: runner.os == 'Linux'
       run: |
@@ -41,6 +43,7 @@ jobs:
         .\venv_create.cmd ${{ env.PYTHON_VERSION }}
         cd ..\..
 
+  # ---- Install dependencies -------------------
     - name: Install dependencies (Linux)
       if: runner.os == 'Linux'
       run: |
@@ -55,6 +58,7 @@ jobs:
         .\pip_reqs_install.cmd
         cd ..\..
 
+  # ---- Tests ----------------------------------
     - name: Run tests with pytest (Linux)
       if: runner.os == 'Linux'
       run: ./prj/venv/bin/pytest test/
@@ -63,6 +67,7 @@ jobs:
       if: runner.os == 'Windows'
       run: .\prj\venv\Scripts\pytest.exe test\
 
+  # ---- MyPy  ----------------------------------
     - name: Run type checking with mypy (Linux)
       if: runner.os == 'Linux'
       run: ./prj/venv/bin/mypy --check-untyped-defs -p test -p src
@@ -71,6 +76,7 @@ jobs:
       if: runner.os == 'Windows'
       run: .\prj\venv\Scripts\mypy.exe --check-untyped-defs -p test -p src
 
+  # ---- PyLint  ----------------------------------
     - name: Run linter with pylint (Linux)
       if: runner.os == 'Linux'
       run:  ./prj/venv/bin/python -m pylint --errors-only src test