Merge pull request #9 from FAIR2-for-research-software/SylviaWhittle/typos

Fix typos

Author: ns-rse

episodes/01-why-test-my-code.Rmd

@@ -20,7 +20,7 @@ exercises: 2
 
 Software testing is the process of checking that code is working as expected. You may have data processing functions or automations that you use in your work - how do you know that they are doing what you expect them to do?
 
-Software testing is most commonly done by writing code (tests) that check that your code work as expected.
+Software testing is most commonly done by writing code (tests) that check that your code works as expected.
 
 This might seem like a lot of effort, so let's go over some of the reasons you might want to add tests to your project.
 
@@ -38,7 +38,7 @@ def add(a, b):
 
 When writing this function, I made a mistake. I accidentally wrote `a - b` instead of `a + b`. This is a simple mistake, but it could have serious consequences in a project.
 
-When writing the code, I could have tested this function by manually trying it with different input and checking the output, but:
+When writing the code, I could have tested this function by manually trying it with different inputs and checking the output, but:
 
 - This takes time.
 - I might forget to test it again when we make changes to the code later on.

episodes/02-simple-tests.Rmd

@@ -22,7 +22,7 @@ exercises: 2
 ## Your first test
 
 The most basic thing you will want to do in a test is check that an output for a
-function is correct, by checking that it is equal to a certain value.
+function is correct by checking that it is equal to a certain value.
 
 Let's take the `add` function example from the previous chapter and the test we
 conceptualised for it and write it in code.

episodes/05-testing-exceptions.Rmd

@@ -6,7 +6,7 @@ exercises: 2
 
 :::::::::::::::::::::::::::::::::::::: questions 
 
-- How check that a function raises an exception?
+- How to check that a function raises an exception?
 
 ::::::::::::::::::::::::::::::::::::::::::::::::
 

episodes/07-fixtures.Rmd

@@ -22,7 +22,7 @@ When writing more complex tests, you may find that you need to reuse data or obj
 
 Here is an example of a set of tests that re-use the same data a lot.
 We have a class, `Point`, that represents a point in 2D space. We have a few tests that check the behaviour of the class.
-Notice how we have to repeat the extact same setup code in each test.
+Notice how we have to repeat the exact same setup code in each test.
 
 ```python
 

episodes/09-testing-output-files.Rmd

@@ -153,7 +153,7 @@ Here we have told pytest that we want it to compare the output of the `test_plot
 (make sure you are in the base directory in your project and not in the plotting folder)
 
 ```bash
-pytest --mpl-generate-path=plotitng/test_plots
+pytest --mpl-generate-path=plotting/test_plots
 ```
 
 This tells pytest to run the test but instead of comparing the result, it will save the result into the `test_plots` directory for use in future tests.

episodes/10-CI.Rmd

@@ -114,11 +114,9 @@ Now that you have created the `tests.yaml` file, you need to upload it to GitHub
 
 The typical use-case for a CI system is to run the tests whenever a pull request is made to the main branch to add a feature.
 
-- Go to your GitHub repository
-
 <!-- figure
 ![branch protection visual instruction](episodes/fig/github-branch-protection.png) -->
-
+- Go to your GitHub repository
 - Click on the "Settings" tab
 - Scroll down to "Branches"
 - Under "Branch protection rules" / "Branch name pattern" type "main"