Tariq-droid / pe

0 stars 0 forks source link

missing loop in stats UML #20

Open Tariq-droid opened 1 year ago

Tariq-droid commented 1 year ago

image.png

soc-pe-bot commented 1 year ago

Team's Response

Hey, thank you for being meticulous in checking our sequence diagram.

It is understandable why you would think that a loop to count the tags is missing from the sequence diagram. However, the counting of tags is not done in any of the shown classes, as the development team made a design choice to create a separate utility class (TaskByTagTracker), outside of StatsCommand and Model, specifically to count the tags. Thus, the loop was not shown since the involved class has been abstracted away.

We chose to exclude the TaskByTagTracker class that is used to do the counting as per instructions in the DG component here (https://nus-cs2103-ay2223s2.github.io/website/schedule/week13/project.html),

image.png

to keep things comprehensible, not necessarily comprehensive. Also, as per the textbook on sequence diagram here (https://nus-cs2103-ay2223s2.github.io/website/se-book-adapted/chapters/modeling.html#sequence-diagrams-basic),

image.png

the point of including a sequence diagram is to show important interactions, and we felt that overcrowding the sequence diagram with information about how specific utility classes are used to do the counting may draw the attention away from the actual important interactions that we want to showcase.

Once again, thank you for pointing out this, as you probably put a lot of thought into this feature and our sequence diagram. However, we feel that our sequence diagram has enough information as it is now, to serve its main purpose to model interactions between the important components.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [Although I do understand the point of keeping it simple but the counting is an essential part of the function]


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]