search

YHWong20 / pe

0 stars 0 forks source link

Missing diagrams for Checker component #17

Open YHWong20 opened 7 months ago

YHWong20 commented 7 months ago

Missing sequence diagrams and class diagrams.

image.png

soc-se-bot commented 6 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Missing diagrams for all components

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.

No class diagrams or sequence diagrams.

Everything is crammed into an overall diagram, and this makes the overall diagrams hard to understand and read.

[original: nus-cs2113-AY2324S2/pe-interim#2411] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

we did made class diagrams for each class , but the diagrams were in /doc and we didn't put it in the DG , so maybe it will be eaiser to understand if we do put those diagrams in DG

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** This is fair. I will accept that this issue is a duplicate of the parent issue (after all, if the parent issue is addressed, this issue would be addressed as well). However, I do not agree with the VeryLow severity rating here. To re-state over the explanation I've provided in the parent issue: > I would believe that this issue is likely to be of a Low severity instead (I recognize that the Medium rating I gave was not too justified either). > > The lack of these diagrams will cause an inconvenience for the reader. Even though detailed descriptions are provided in the DG, I would also like to point out that the lack of diagrams will make it difficult for the reader to visualize and understand what exactly they're reading. I believe that the lack of such diagrams can indeed create some hindrance for the reader, as they'll need to continually scroll up to your overall diagrams, and cross-reference what they're reading with the overall diagram. > > As this is not a cosmetic issue, VeryLow severity rating doesn't quite make sense here. Thus, I hope you understand why I disagree with the new severity rating.