search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Incorrect sequence diagram notation #2339

Open nus-pe-bot opened 2 months ago

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

Throughout the DG, there are multiple sequence diagrams where the leftmost entity is seen to be :User where the existence of a User class is nowhere to be found. If the intention was to have the :User entity represent an actual user, then an actual user entity (refer to the last attached image) would have been more clear to future developers reading the documentation.

Examples are attached below: image.png

image.png

image.png

CS2113 Website Example:

image.png

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

Joshuahoky commented 2 months ago

Team's Response

Thank you for pointing this out. However as this is merely a cosmetic issue in the DG, we feel that the severity should be very low.

Duplicate status (if any):

--