search

maanyos / pe

0 stars 0 forks source link

too much detail in API class diagram #9

Open maanyos opened 2 years ago

maanyos commented 2 years ago

There are too many moethods listed in API class , most of which are not explained in the description, and some are quite insignificant, like getters

image.png

nus-pe-script commented 2 years ago

Team's Response

Hi, thank you for raising up this issue. We understand your concern however we do not think having too much detail as an issue in the developer guide. The object class diagram is there to provide as much information as possible to prospective developers to aid them in their development.

However, we will be dropping the severity level to very low since we do agree that we should have explained more if not most of the functions listed in the class diagram (some of them are already listed in section 3.3). Reason being because sequence diagram below has stated what is needed and crucial for using the API class directly.

Screen Shot 2022-11-14 at 10.29.07.png

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: [replace this with your explanation]