search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Sequence Diagram in Developer Guide does not flow well #900

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.

Description: The sequence diagram on page 4 of the Developer Guide does not flow well and would confuse developers who are reading this for the first time.

As seen in the screenshot below, Parser -> Command, 4 Execute, I assume the Parser calls the execute method in Command, however, it shows that Command->Storage 5 Save Logs to File afterwards.

The next line is then Parser->Scanner for the input, and does not show if the Storage returns to Command, which then returns to the Parser.

Editing to add the second diagram below, under Log Package, which is very hard to follow.

Screenshot:

image.png

image.png

[original: nus-cs2113-AY2324S2/pe-interim#823] [original labels: severity.Medium type.DocumentationBug]

nikhil-2101 commented 6 months ago

Team's Response

No details provided by team.

Duplicate status (if any):

--