search

nus-cs2103-AY1920S2 / pe-dev-response

0 stars 0 forks source link

Sequence diagram for edit supplier #2431

Open nus-pe-bot opened 4 years ago

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

Sequence diagram has too many parts going on and is very long.

Should have been broken down into parts and each part referenced (e.g, command parsing, command execution).

image.png

[original: nus-cs2103-AY1920S2/pe-interim#2411]

LiuChao93 commented 4 years ago

Team's Response

This command has the most challenging implementation and hence we include the full steps of the command for the convenience of the future developers who would want to improve this feature. We understand that the UML diagrams should include only what is necessary but due to the difficulty of this command, such as defining multiple classes between different classes, we include the full steps to provide an easily traceable view to the developer. The issue should not be marketed as medium as it does not affect the correctness of the DG, it just may have some cosmetic issues which a developer could be easily solved by clicking the diagram to enlarge it.

Duplicate status (if any):

--