add dummy docstring

src/monitoring_tests/competition_endpoint_test/endpoint_test.py

@@ -1,3 +1,6 @@
+"""
+To be completed
+"""
 from typing import List, Tuple, Dict, Any
 from src.monitoring_tests.template_test import TemplateTest
 from src.helper_functions import (
@@ -9,6 +12,9 @@
 # this class implements the EBBO test based solely on the competition endpoint.
 # the way to run the test is by calling the cow_endpoint_test() method
 class EndpointTest(TemplateTest):
+ """
+ To be completed
+ """
  @classmethod
  def compare_orders_surplus(cls, competition_data: Dict[str, Any]) -> None:
  """

src/monitoring_tests/template_test.py

@@ -1,3 +1,6 @@
+"""
+To be completed
+"""
 import json
 from typing import List, Dict, Any
 from fractions import Fraction
@@ -21,7 +24,9 @@
 # multiple tests might find useful. The intended usage is that every new test
 # is a subclass of this class.
 class TemplateTest:
-
+ """
+ To be completed
+ """
  load_dotenv()
 
  ###### class variables