search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Incorrect Sequence Diagram #2209

Open nus-se-script opened 2 months ago

nus-se-script commented 2 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

The UML diagram for Get Savings Insights is incorrect. First, one method from Parser is not pointing to anything. Second, return command from Parser is connecting to the class box. There're mistakes in other UML as well.

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

jasraa commented 2 months ago

Team's Response

I appreciate the report on the UML sequence diagram error within the 'Get Savings Insights' documentation.

It is important to note that immediately following the diagram, the correct sequence of execution is clearly outlined, providing an accurate step-by-step narrative of the process.

image.png

This textual clarification allows for easy cross-referencing, ensuring users can quickly rectify any confusion caused by the diagram. The application’s functionality remains unaffected. Hence, I suggest the severity of this issue be revised from a severity.Medium to a severity.Low, indicating a minor documentation inconsistency that can be readily checked against the correct information provided in the "sequential flow of execution when a user commands to get savings insights" explanation.

Duplicate status (if any):

--