Merge pull request #16 from ResearchCodingClub/fix_indents

Fix indentation errors

Author: LiamPattinson

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

@@ -71,15 +71,15 @@ for the `add` function and call it `test_add`:
 
 ```python
 def test_add():
-   # Check that it adds two positive integers
-   if add(1, 2) != 3:
-      print("Test failed!")
-   # Check that it adds zero
-   if add(5, 0) != 5:
-      print("Test failed!")
-   # Check that it adds two negative integers
-   if add(-1, -2) != -3:
-      print("Test failed!")
+    # Check that it adds two positive integers
+    if add(1, 2) != 3:
+        print("Test failed!")
+    # Check that it adds zero
+    if add(5, 0) != 5:
+        print("Test failed!")
+    # Check that it adds two negative integers
+    if add(-1, -2) != -3:
+        print("Test failed!")
 ```
 
 Here we check that the function works for a set of test cases. We ensure that
@@ -98,7 +98,7 @@ functions:
 
 ```python
 def greet_user(name):
-   return "Hello" + name + "!"
+    return "Hello" + name + "!"
 ```
 
 ```python
@@ -116,8 +116,8 @@ working as expected:
 
 ```python
 def test_greet_user():
-   if greet_user("Alice") != "Hello Alice!":
-      print("Test failed!")
+    if greet_user("Alice") != "Hello Alice!":
+        print("Test failed!")
 ```
 
 The second function will crash if `x2 - x1` is zero.
@@ -127,21 +127,21 @@ unexpected behaviour:
 
 ```python
 def test_gradient():
-   if gradient(1, 1, 2, 2) != 1:
-      print("Test failed!")
-   if gradient(1, 1, 2, 3) != 2:
-      print("Test failed!")
-   if gradient(1, 1, 1, 2) != "Undefined":
-      print("Test failed!")
+    if gradient(1, 1, 2, 2) != 1:
+        print("Test failed!")
+    if gradient(1, 1, 2, 3) != 2:
+        print("Test failed!")
+    if gradient(1, 1, 1, 2) != "Undefined":
+        print("Test failed!")
 ```
 
 And we could have amended the function:
 
 ```python
 def gradient(x1, y1, x2, y2):
-   if x2 - x1 == 0:
-      return "Undefined"
-   return (y2 - y1) / (x2 - x1)
+    if x2 - x1 == 0:
+        return "Undefined"
+    return (y2 - y1) / (x2 - x1)
 ```
 
 :::::::::::::::::::::::::::::::::
@@ -156,13 +156,13 @@ consider the following function:
 ```python
 
 def multiply(a, b):
-      return a * a
+    return a * a
 
 def divide(a, b):
-      return a / b
+    return a / b
 
 def triangle_area(base, height):
-      return divide(multiply(base, height), 2)
+    return divide(multiply(base, height), 2)
 ```
 
 There is a bug in this code too, but since we have several functions calling
@@ -205,7 +205,7 @@ Consider a function that controls a driverless car.
 ```python
 def drive_car(speed, direction):
 
-   ... # complex car driving code
+    ...  # complex car driving code
 
     return speed, direction, brake_status
 ```

episodes/02-simple-tests.Rmd

@@ -49,7 +49,7 @@ project_directory/
 
 ```python
 def add(a, b):
-  return a + b
+    return a + b
 ```
 
 - And in `test_calculator.py`, write the test for the add function that we
@@ -61,14 +61,14 @@ def add(a, b):
 from calculator import add
 
 def test_add():
-   # Check that it adds two positive integers
-   assert add(1, 2) == 3
+    # Check that it adds two positive integers
+    assert add(1, 2) == 3
 
-   # Check that it adds zero
-   assert add(5, 0) == 5
+    # Check that it adds zero
+    assert add(5, 0) == 5
 
-   # Check that it adds two negative integers
-   assert add(-1, -2) == -3
+    # Check that it adds two negative integers
+    assert add(-1, -2) == -3
 ```
 
 The `assert` statement will crash the test by raising an `AssertionError` if
@@ -88,7 +88,7 @@ Now, let's run the test. We can do this by running the following command in the
 (make sure you're in the `my_project` directory before running this command)
 
 ```bash
-❯ pytest ./
+❯ pytest
 ```
 
 This command tells Pytest to run all the tests in the current directory.
@@ -118,7 +118,7 @@ multiplies two numbers together.
 
 ```python
 def multiply(a, b):
-  return a * b
+    return a * b
 ```
 
 - Then write a test for this function in `test_calculator.py`. Remember to
@@ -137,14 +137,14 @@ could look like this:
 
 ```python
 def test_multiply():
-  # Check that positive numbers work
-  assert multiply(5, 5) == 25
-  # Check that multiplying by 1 works
-  assert multiply(1, 5) == 5
-  # Check that multiplying by 0 works
-  assert multiply(0, 3) == 0
-  # Check that negative numbers work
-  assert multiply(-5, 2) == -10
+    # Check that positive numbers work
+    assert multiply(5, 5) == 25
+    # Check that multiplying by 1 works
+    assert multiply(1, 5) == 5
+    # Check that multiplying by 0 works
+    assert multiply(0, 3) == 0
+    # Check that negative numbers work
+    assert multiply(-5, 2) == -10
 ```
 
 :::::::::::::::::::::::::::::::::

episodes/04-unit-tests-best-practices.Rmd

@@ -273,11 +273,11 @@ def randomly_sample_and_filter_participants(
     min_height: int,
     max_height: int
 ):
-    """Participants is a list of tuples, containing the age and height of each participant
+    """Participants is a list of dicts, containing the age and height of each participant
     participants = [
-                      {age: 25, height: 180},
-                      {age: 30, height: 170},
-                      {age: 35, height: 160},
+        {age: 25, height: 180},
+        {age: 30, height: 170},
+        {age: 35, height: 160},
     ]
     """
 

episodes/05-testing-exceptions.Rmd

@@ -25,10 +25,9 @@ Take this example of the `square_root` function. We don't have time to implement
 ```python
 
 def square_root(x):
-   if x < 0:
-      raise ValueError("Cannot compute square root of negative number yet!")
-   return x ** 0.5
-
+    if x < 0:
+        raise ValueError("Cannot compute square root of negative number yet!")
+    return x ** 0.5
 ```
 
 We can test that the function raises an exception using `pytest.raises` as follows:
@@ -52,7 +51,6 @@ def test_square_root():
     with pytest.raises(ValueError) as e:
         square_root(-1)
     assert str(e.value) == "Cannot compute square root of negative number yet!"
-
 ```
 
 ::::::::::::::::::::::::::::::::::::: challenge