nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Developers Guide Diagram error #3040

Open nus-se-script opened 1 year ago

nus-se-script 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.


Screenshot 2023-11-17 at 5.15.59 PM.png

Screenshot 2023-11-17 at 5.21.30 PM.png

After looking through the code, it seems that delete command parser and add appointment command parser should have ended its lifeline after returning the commands it creates and soon to be collected by garbage collection. The diagram displays some inaccuracies as these objects are ready for garbage collection but the timeline is not ended.

EDIT: It seems this is the case for all the parsers. Thus all the corresponding diagrams in the DG are incorrect and should be updated.

Screenshot 2023-11-17 at 5.25.00 PM.png


[original: nus-cs2103-AY2324S1/pe-interim#2409] [original labels: severity.Low type.DocumentationBug]

ryanongwx commented 1 year ago

Team's Response

As seen from the screenshot from the course website, object deletion is not important in languages such as Java and does not affect the understanding of the diagram. Hence, we chose to omit it to make the diagram simpler and make the focus on the interaction between the various entities in the system.

telegram-cloud-photo-size-5-6255910309948668598-y.jpg

Duplicate status (if any):

--