Merge pull request #31 from UBC-MDS/insertion_sort_test

added docstrings to test functions

tests/test_insertion_sort.py

@@ -4,34 +4,41 @@
 
 
 def test_insertion_sort(test_data1):
+    """test that function returns a sorted list given an unsorted list"""
     expected = [1,2,3,4,5,6,7,8]
     actual = insertion_sort(test_data1)
     assert actual == expected
 
 def test_empty(test_data_empty):
+    """test that function can handle an empty list"""
     actual = insertion_sort(test_data_empty)
     assert isinstance(actual,list)
     assert len(actual) == 0
 
 def test_sorted(test_data_sorted):
+    """test that function returns a sorted list given an already sorted list"""
     expected = [1, 2, 3, 4, 5, 6, 7, 8]
     actual = insertion_sort(test_data_sorted)
     assert actual == expected
 
 def test_string_error(test_data_error2):
+    """test that function returns a typer error given a string is passed"""
     with pytest.raises(TypeError):
         insertion_sort(test_data_error2)
 
 def test_wrong_values(test_data_error):
+    """test that function returns type error is a list is passed with various items in it"""
     with pytest.raises(TypeError):
         insertion_sort(test_data_error)
 
 def test_ascending_false(test_data1):
+    """test that function is able to return ascending sorted list"""
     expected = [8,7,6,5,4,3,2,1]
     actual = insertion_sort(test_data1, ascending = False)
     assert actual == expected
 
 def test_one_float(test_data_float):
+    """test that function can handle floats as well as ints"""
     expected = [1,2,3.0,4,5]
     actual = insertion_sort(test_data_float)
     assert actual == expected