add docs to optional test 12 based on issue #8

StateFarmInsCodingCompetition · Oct 15, 2023 · a93a3c8 · a93a3c8
1 parent 3aefd3e
commit a93a3c8
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 4 deletions.
diff --git a/...c/main/java/com/statefarm/codingcompetition/simpledatatool/controller/SimpleDataTool.java b/...c/main/java/com/statefarm/codingcompetition/simpledatatool/controller/SimpleDataTool.java
@@ -219,7 +219,10 @@ public float calculateDisasterClaimDensity(int id) {
     // region TestSet4
 
     /**
-     * Gets the top three months with the highest total claim cost
+     * Gets the top three months with the highest number of claims
+     * 
+     * OPTIONAL! OPTIONAL! OPTIONAL!
+     * AS OF 9:21CDT, TEST IS OPTIONAL. SEE GITHUB ISSUE #8 FOR MORE DETAILS
      * 
      * Hint:
      * - Month should be full name like 01 is January and 12 is December

diff --git a/java/src/test/java/com/statefarm/codingcompetition/simpledatatool/TestSet4.java b/java/src/test/java/com/statefarm/codingcompetition/simpledatatool/TestSet4.java
@@ -16,6 +16,10 @@ public void initialize() {
         controller = new SimpleDataTool();
     }
 
+    /**
+     * OPTIONAL! OPTIONAL! OPTIONAL!
+     * AS OF 9:21CDT, TEST IS OPTIONAL. SEE GITHUB ISSUE #8 FOR MORE DETAILS
+     */
     @Test
     public void test12_getTopThreeMonthsWithHighestNumOfClaimsDesc() {
         String[] topThreeMonths = controller.getTopThreeMonthsWithHighestNumOfClaimsDesc();

diff --git a/nodejs/application.test.js b/nodejs/application.test.js
@@ -117,6 +117,10 @@ describe("Test Set Three", () => {
 });
 
 describe("Test Set Four", () => {
+    /**
+     * OPTIONAL! OPTIONAL! OPTIONAL!
+     * AS OF 9:21 CDT, TEST IS OPTIONAL. SEE GITHUB ISSUE #8 FOR MORE DETAILS
+     */
     test("Test 12 - getTopThreeMonthsWithHighestNumOfClaimsDesc", () => {
         const topThreeMonths =
             controller.getTopThreeMonthsWithHighestNumOfClaimsDesc();

diff --git a/nodejs/simpleDataTool.js b/nodejs/simpleDataTool.js
@@ -156,7 +156,10 @@ class SimpleDataTool {
 
     /**
      * Gets the top three months with the highest total claim cost.
-     *
+     * 
+     * OPTIONAL! OPTIONAL! OPTIONAL!
+     * AS OF 9:21 CDT, TEST IS OPTIONAL. SEE GITHUB ISSUE #8 FOR MORE DETAILS
+     * 
      * Hint:
      *     Month should be full name like 01 is January and 12 is December.
      *     Year should be full four-digit year.

diff --git a/python/simple_data_tool.py b/python/simple_data_tool.py
@@ -221,7 +221,10 @@ def calculate_disaster_claim_density(self, disaster_id):
     # region TestSetFour
 
     def get_top_three_months_with_highest_num_of_claims_desc(self):
-        """Gets the top three months with the highest total claim cost
+        """Gets the top three months with the highest number of claims
+
+        OPTIONAL! OPTIONAL! OPTIONAL!
+        AS OF 9:21CDT, TEST IS OPTIONAL. SEE GITHUB ISSUE #8 FOR MORE DETAILS
 
         Hint:
             Month should be full name like 01 is January and 12 is December

diff --git a/python/test/test_simple_data_tool.py b/python/test/test_simple_data_tool.py
@@ -142,7 +142,12 @@ def test_calculate_disaster_claim_density(self, controller):
 class TestSetFour:
 
     def test_get_top_three_months_with_highest_num_of_claims_desc(self, controller):
-        """Test 12"""
+        """Test 12
+
+        OPTIONAL! OPTIONAL! OPTIONAL!
+        AS OF 9:21CDT, TEST IS OPTIONAL. SEE GITHUB ISSUE #8 FOR MORE DETAILS
+
+        """
         top_three_months = controller.get_top_three_months_with_highest_num_of_claims_desc()
         assert len(top_three_months) == 3
         assert top_three_months[0] == 'April 2023'