nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Missing sequence diagram for "EditCommand" #4212

Open nus-se-script opened 6 months ago

nus-se-script commented 6 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.


I could not find the sequence diagram for EditCommand in DG


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

jayllo-c commented 5 months ago

Team's Response

Thank you for the response. However, we feel that this report is a non-issue and should be rejected.

Sufficient documentation in the form of a UML activity diagram is already given.

There is no requirement for a sequence diagram for each feature. It would become repetitive as EditCommand follows a similar structure to the Add and Find Commands that we have already had sequence diagrams for.

Moreover, since the lack of a repeated sequence diagram is only likely to cause a minor inconvenience to the user at best, we propose a downgrade to severity.Low.

Duplicate status (if any):

--