StateFarmInsCodingCompetition / 2023-StateFarm-CodingCompetition

Welcome to the 2023 State Farm Coding Competition. If you have questions during the coding competition, please contact codingcompetition@statefarm.com or you can submit an issue through GitHub.
https://codingcompetition.statefarm.com
Apache License 2.0
6 stars 48 forks source link

Contradictory method documentation #8

Open ianwzhang1 opened 1 year ago

ianwzhang1 commented 1 year ago

The method get_top_three_months_with_highest_num_of_claims_desc and return hint in the documentation (three strings of month and year, descending order of highest claims) implies that we need to find the months with the most number of claims, but the method description states Gets the top three months with the highest total claim cost. Do we need to find the three months with the most disasters or with the highest claim cost?

J1411 commented 1 year ago

Sorry about this, but we've decided to strike this test from the necessary tests to pass. You can still work on it for bonus credit if you really want, but it will not impact your score negatively.

Method desc should be "Get the top three months with the highest number of claims". The list of months should return as:

J1411 commented 1 year ago

We're updating the repo, documentation, and emailing out right now too

J1411 commented 1 year ago

Clarifying per language which stub and test can be ignored based on this:

Updated docstrings too to prevent further confusion.