search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Incorrect description of sequence diagram in DG #4631

Open nus-pe-bot opened 6 months ago

nus-pe-bot 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.

image.png

execute("delete 1") does not match the sequence diagram

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

hjungwoo01 commented 6 months ago

Team's Response

execute("delete 1") is an example API call. The sequence diagram shows 3 different API calls separated by commas as we support 3 different ways of deleting - meant to showcase the alternative box and where the other API calls go. These three were shown together in one diagram as to not be repetitive.

Duplicate status (if any):

--