Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contradictory method documentation #8

Open
ianwzhang1 opened this issue Oct 15, 2023 · 3 comments
Open

Contradictory method documentation #8

ianwzhang1 opened this issue Oct 15, 2023 · 3 comments

Comments

@ianwzhang1
Copy link

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
Copy link
Member

J1411 commented Oct 15, 2023

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:

  • April 2023
  • November 2022
  • January 2023 OR February 2023 OR October 2022

@J1411
Copy link
Member

J1411 commented Oct 15, 2023

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

J1411 added a commit that referenced this issue Oct 15, 2023
@J1411
Copy link
Member

J1411 commented Oct 15, 2023

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

  • For Java: TestSet4.test12_getTopThreeMonthsWithHighestNumOfClaimsDesc and SimpleDataTool.getTopThreeMonthsWithHighestNumOfClaimsDesc
  • For NodeJS: Test 12 - getTopThreeMonthsWithHighestNumOfClaimsDesc inside application.test.js and getTopThreeMonthsWithHighestNumOfClaimsDesc inside simpleDataTool.js
  • For Python: get_top_three_months_with_highest_num_of_claims_desc in simple_data_tool.py and test_get_top_three_months_with_highest_num_of_claims_desc in test_simple_data_tool.py

Updated docstrings too to prevent further confusion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants