search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Repetitive sequence diagram #457

Open nus-se-script opened 2 months ago

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

Both Add command sequence diagram and Edit command sequence diagram are very identical to each other, with only the difference of the command input.

Edit: image.png

Add: image.png

However, there are some difference in the implementation of add command and edit command in the codes.

For example, edit command would call 

        model.setPerson(personToEdit, editedPerson);
        model.updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS);

in the EditCommand.java.

I think this is what sets a part edit command from add command and should be reflected in the sequence diagram.

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

eunrcn commented 2 months ago

Team's Response

We are not showing the difference between AddCommand and EditCommand, but rather we are just showing the sequence diagram for edit and add individually and separately

And the two lines you included: model.setPerson(personToEdit, editedPerson); model.updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS);

are not meant to be in the sequence diagram.

Duplicate status (if any):

--