📝 Add docstrings to feat/algorithms-tournament-winner

Docstrings generation was requested by @BrianLusina.

* #93 (comment)

The following files were modified:

* `algorithms/arrays/sorted_squared_array/test_sorted_squared_array.py`
* `puzzles/arrays/tournament_winner/__init__.py`
* `puzzles/arrays/tournament_winner/test_tournament_winner.py`

Author: coderabbitai[bot]

algorithms/arrays/sorted_squared_array/test_sorted_squared_array.py

@@ -11,14 +11,18 @@ def test_1(self):
         self.assertEqual(expected, actual)
 
     def test_2(self):
-        """for an input of [1] it should return [1]"""
+        """
+        Tests that `sorted_squared_array` returns `[1]` when given a single-element input `[1]`.
+        """
         input_array = [1]
         expected = [1]
         actual = sorted_squared_array(input_array)
         self.assertEqual(expected, actual)
 
     def test_3(self):
-        """for an input of [-7,-3,2,3,11] it should return [4,9,9,49,121]"""
+        """
+        Test that `sorted_squared_array` correctly returns a sorted list of squares for an input containing both negative and positive integers.
+        """
         input_array = [-7,-3,2,3,11]
         expected = [4,9,9,49,121]
         actual = sorted_squared_array(input_array)
@@ -27,21 +31,27 @@ def test_3(self):
 
 class SortedSquaredArray2TestCases(unittest.TestCase):
     def test_1(self):
-        """for an input of [1,2,3,5,6,8,9] it should return [1, 4, 9,25, 36, 64, 81]"""
+        """
+        Test that `sorted_squared_array_2` returns the sorted squares of a list of positive integers.
+        """
         input_array = [1, 2, 3, 5, 6, 8, 9]
         expected = [1, 4, 9, 25, 36, 64, 81]
         actual = sorted_squared_array_2(input_array)
         self.assertEqual(expected, actual)
 
     def test_2(self):
-        """for an input of [1] it should return [1]"""
+        """
+        Test that `sorted_squared_array_2` returns `[1]` when given a single-element input `[1]`.
+        """
         input_array = [1]
         expected = [1]
         actual = sorted_squared_array_2(input_array)
         self.assertEqual(expected, actual)
 
     def test_3(self):
-        """for an input of [-7,-3,2,3,11] it should return [4,9,9,49,121]"""
+        """
+        Test that sorted_squared_array_2 correctly returns the sorted squares of a mixed-sign integer array.
+        """
         input_array = [-7,-3,2,3,11]
         expected = [4,9,9,49,121]
         actual = sorted_squared_array_2(input_array)

puzzles/arrays/tournament_winner/__init__.py

@@ -4,6 +4,16 @@
 def tournament_winner(competitions: List[List[str]], results: List[int]) -> str:
     # We need to store a dictionary with the name of the team as the key and the number of points as the value
     # 3 points for a win, 0 points for a loss
+    """
+    Determines the winner of a tournament based on match results.
+    
+    Parameters:
+        competitions (List[List[str]]): Each sublist contains two team names, representing a match between a home and away team.
+        results (List[int]): Each integer corresponds to the outcome of the match at the same index in `competitions` (0 for away team win, 1 for home team win).
+    
+    Returns:
+        str: The name of the team with the highest total points at the end of the tournament.
+    """
     winner = ""
     teams: Dict[str, int] = {}
     for competition, result in zip(competitions, results):

puzzles/arrays/tournament_winner/test_tournament_winner.py

@@ -3,6 +3,9 @@
 
 class TournamentWinnerTestCase(unittest.TestCase):
     def test_1(self):
+        """
+        Test that `tournament_winner` returns the correct winner for a sample set of competitions and results.
+        """
         competitions = [["HTML", "C#"], ["C#", "Python"], ["Python", "HTML"]]
         results = [0, 0, 1]
         expected = "Python"