search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Wrong position for exception call in application loop Sequence diagram for DG #1536

Open nus-se-script opened 5 months ago

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

As outlined by the red circle, the exception call indicated by the command class does not comply with cs2113 standards as it is isolated with no previous calls before it to the Command class, which may also cause confusion to the user. This could be improved instead by moving it to an alt frame under getCommand(userInput)

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

sxfoo commented 5 months ago

Team's Response

That is not an exception call, the red X represents object deletion

From the textbook: image.png

"Although languages such as Java do not support a delete operation (because they use automatic memory management), you can use the object deletion notation to indicate the point at which the object becomes ready to be garbage-collected (i.e., the point at which it ceases to be referenced)."

Duplicate status (if any):

--