search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Inaccurate Sequence Diagram [Page 6] #5619

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years 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.

image.png

Here when delete is called, there should also be a call to the model.commitAddressBook() method since delete is an undoable command.

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

yeo-yiheng commented 2 years ago

Team's Response

We understand the concerns regarding this issue raised. However, we crafted this sequence diagram considering that this sequence diagram must be applicable to all XYZCommands. If we were to include commitAddressBook() call, we would be alienating the commands that cannot be undone. Thus, we opted for a sequence diagram that does not include the call to commitAddressBook() in order to preserve a common architecture that applies to all commands.

Duplicate status (if any):

--