markdown source builds

Auto-generated via `{sandpaper}`
Source  : b93e579
Branch  : main
Author  : Connor Aird <c.aird@ucl.ac.uk>
Time    : 2025-11-04 10:02:41 +0000
Message : Merge pull request #33 from UCL-ARC/32-add-refactoring-lesson

Add refactoring lesson

Author: actions-user

1-intro-to-unit-tests.md 1-what-is-a-unit-tests.md1-intro-to-unit-tests.md renamed to 1-what-is-a-unit-tests.md

@@ -1,5 +1,5 @@
 ---
-title: "Introduction to Unit Testing"
+title: "What is a Unit Test"
 teaching: 
 exercises: 
 ---
@@ -8,20 +8,18 @@ exercises:
 
 - What is unit testing?
 - Why do we need unit tests?
-- What makes src code difficult to unit test?
 
 ::::::::::::::::::::::::::::::::::::::::::::::::
 
 ::::::::::::::::::::::::::::::::::::: objectives
 
 - Define the key aspects of a good unit test (isolated, testing minimal functionality, fast, etc).
 - Understand the key anatomy of a unit test in any language.
-- Explain the benefit of unit tests on top of integration/e2e tests.
+- Explain the benefit of unit tests on top of other types of tests.
 - Understand when to run unit tests.
 
 ::::::::::::::::::::::::::::::::::::::::::::::::
 
-## What is unit testing?
 
 Unit testing is a way of verifying the validity of a code base by testing its smallest individual components, or **units**.
 
@@ -36,14 +34,14 @@ Several key aspects define a unit test. They should be...
 
 ::::::::::::::::::::::::::::::::::::: callout
 
-#### Other forms of testing
+### Other forms of testing
 
 There are other forms of testing, such as integration testing in which two or more units of a code base are tested to verify that they work together, or that they are correctly **integrated**.
 However, today we are focusing on unit tests as it is often the case that many of these larger tests are written using the same test tools and frameworks, hence we will make progress with both by starting with unit testing.
 
 ::::::::::::::::::::::::::::::::::::::::::::::::
 
-### What does a unit test look like?
+## What does a unit test look like?
 
 All unit tests tend to follow the same pattern of Given-When-Then.
 
@@ -59,7 +57,7 @@ All unit tests tend to follow the same pattern of Given-When-Then.
 
 ::::::::::::::::::::::::::::::::::::: challenge 
 
-#### Challenge 1: Write a unit test in sudo code.
+### Challenge 1: Write a unit test in sudo code.
 
 Assuming you have a function `reverse_array` which reverses the order of an allocated array. Write a unit test in pseudo code for `reverse_array` using the pattern above.
 
@@ -83,7 +81,7 @@ for each element in `input_array`:
 :::::::::::::::::::::::::::::::::
 ::::::::::::::::::::::::::::::::::::::::::
 
-### When should unit tests be run?
+## When should unit tests be run?
 
 A major benefit of unit tests is the ability to identify bugs at the earliest possible stage. Therefore, unit tests should be run frequently throughout the development process. Passing unit tests give you and your collaborators confidence that changes to your code aren't modifying the previously expected behaviour, so run your unit tests...
 
@@ -96,7 +94,7 @@ A major benefit of unit tests is the ability to identify bugs at the earliest po
 
 Basically, all the time.
 
-### Do we really need unit tests?
+## Do we really need unit tests?
 
 Yes! 
 
@@ -118,7 +116,7 @@ This is much clearer. We immediately have an idea of what could be going wrong a
 
 ::::::::::::::::::::::::::::::::::::: challenge 
 
-### Challenge 2: Unit test bad practices
+## Challenge 2: Unit test bad practices
 
 Take a look at [1-into-to-unit-tests/challenge](https://github.com/UCL-ARC/fortran-unit-testing-exercises/tree/main/episodes/1-into-to-unit-tests/challenge) in the exercises repository.