search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Verbose sequence diagram for Logic component interactions #698

Open nus-pe-bot opened 3 years ago

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

Screenshot 2021-11-12 172610.png

The commands in the sequence diagram are verbose and difficult to read. Consider use minimal notation to make the diagram simpler.

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

zhenxuantan commented 3 years ago

Team's Response

The verbosity is needed to explain how the different components interact with each other. The diagram is clear and allows aspiring developers to understand how the parsing works. If we trim the command, it will not reflect how the parsing works. Minimal notation would render the diagram useless. As such, the bug is downgraded to the severity of "VeryLow" and is rejected.

Duplicate status (if any):

--