nus-cs2113-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Sequence diagram has too much detail and is hard to read #771

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year 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 This particular sequence diagram also has small text. It should probably be broken down into each of the modify functions


[original: nus-cs2113-AY2223S1/pe-interim#743] [original labels: severity.Low type.DocumentationBug]

shengiv commented 1 year ago

Team's Response

We believe that it is important to give the big picture of the ModifyFlightNumCommand(). We already removed trivial methods and only showed important methods in the sequence diagram to improve readability and to get a sense of how the command works as a whole.

image.png

Duplicate status (if any):

--