small changes

Author: clmould

.github/workflows/process.yml

@@ -117,7 +117,7 @@ jobs:
         run: hatch run lint:fmt
 
   tracking:
-    # update tracker to include the MFILEs created by the run-tracked-files job
+    # update tracker to include the MFILEs created by the run-tracking-inputs job
     concurrency:
       group: tracking-jobs
       cancel-in-progress: false

documentation/source/development/ci-guide.md

@@ -7,13 +7,13 @@ Our GitHub actions Continuous Integration (CI) pipeline serves to ensure each br
 | ---- | ------------- |
 | unit-test | Installs PROCESS and runs the unit tests. The job will fail if any of the unit tests fail. |
 | integration-test | Installs PROCESS and runs the integration tests. The job will fail if any of the integration tests fail. |
-| regression-test | Installs PROCESS and runs the regression tests with a 0.2% and 5% tolerance, respectively. The job will fail if any of the regression tests fail. The job uses tracked outputs for regression test comparisons. |
+| regression-test | Installs PROCESS and runs the regression tests with a 0.2% and 5% tolerance, respectively. The job will fail if any of the regression tests fail. The job uses tracked MFILEs for regression test comparisons. |
 | run-tracking-inputs | Installs PROCESS and runs the regression test input files, archiving the output MFILEs. Only runs on the **main** branch. |
 | tracking | Collects MFILEs for input files of interest and creates a dashboard of changes in key values over time (one datapoint for each commit on main). Only runs on the **main** branch. |
 | pre-commit-quality-check | ensures the pushed code meets our standards as defined in `.pre-commit-config.yaml`. |
 | docs | Builds and deploys the documentation onto GitHub pages. |
 
-!!! Info Regression files
-    When creating a PR, the tracked MFILEs from the point at which you branched off **main** will be used during the regression test job. This job may fail on your PR. If so, the changes will need to be reviewed. If the changes are accepted (i.e. they come from a necessary change to a model), upon merge to main the 
+!!! Info "Regression Job"
+    When creating a PR, the tracked MFILEs from the point at which you branched off main will be used during the regression test job. This job may fail on your PR. If so, these changes to the output will need to be reviewed. If the changes are accepted (i.e. they come from a necessary change to a model), upon merge to main the 
     `run-tracking-inputs` job will run the regression input files to generate the associated MFILEs to be tracked by the 
-    `tracking job`, and these will now reflect the changes your PR has introduced. Therefore when the regression job runs it will use these updated tracked files, and will pass upon merge to main.
+    `tracking job`, and these will now reflect the changes your PR has introduced. Therefore when the regression job runs upon merge of your code into main, it will use these updated tracked MFILEs, and the regression tests will pass.

documentation/source/development/testing.md

@@ -27,16 +27,16 @@ filename, then call a method to create a plot file, then check that the plot was
 Regression tests detect changes in the entire program's behaviour by checking that for a given
 input, it produces exactly the same output as before those changes. It detects changes in the 
 program's output. Therefore, if your code changes the program's output, it will fail the regression 
-test on the CI for your PR. In this case, that output difference will need to be reviewed and, if accepted,
-the expected (or reference) output will be updated to reflect these changes when your code is merged into `main`.
+test. In this case, that output difference will need to be reviewed and, if accepted,
+the expected (or reference) output will be updated to reflect these changes when your code is merged into main.
 
 Regression tests compare the output of PROCESS locally when running an input file to a reference output stored in a 
 [repository](https://github.com/timothy-nunn/process-tracking-data). The test suite will download the reference output for the commit where the current branch branched off main. This means **each branch is accountable for only its changes since it branched off main**. 
 
 
-!!! Info CI System
+!!! Info "CI System"
     Our tests are run automatically using the Continous Integration (CI) system on GitHub.
-    More information about the jobs run on our CI can be found [here](https://ukaea.github.io/PROCESS/development/ci-guide/)
+    More information about how the jobs run on our CI and update the tracked files can be found [here](https://ukaea.github.io/PROCESS/development/ci-guide/).
 
 
 ## pytest