nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

GradedTest class diagram is unnecessarily detailed #5831

Open nus-se-script opened 9 months ago

nus-se-script commented 9 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


Not all of the methods in the GradedTest class diagram are crucial to the readers understanding of the diagram. Including all the methods makes the diagram's font significantly smaller and hard for users to read. Some of the methods in the GradedTest class diagram could potentially be omitted.

Screenshot 2023-11-17 at 5.31.35 PM.png


[original: nus-cs2103-AY2324S1/pe-interim#5712] [original labels: type.DocumentationBug severity.VeryLow]

raydenlim commented 9 months ago

Team's Response

Hi, thanks for bringing this issue to us. While we understand that the gradedtest class diagram may be too detailed, it was also meant to standardise with the other class diagrams. (e.g The getter methods may be redundant, as there is an association between graded tests and ra1, ra2, midterms, finals and pe. However, we decided to standardise with the other class diagrams, which did include getter methods).

As such, although the gradedtest class diagram may be over detailed, it was an intentional decision. Hence, we will have to reject this bug issue.

Warmest Regards,

Team F.A.K.E.J.A.R.V.I.S.

logofj (2).png

Duplicate status (if any):

--