nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Constructor method should not have `new` keyword #376

Open nus-pe-bot opened 7 months ago

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


In the following sequence diagram under the "Sequence Diagrams Illustrating Exam Modification" section, the constructor method should be AddExamCommand(e) instead following the Class() format in the textbook here. Screenshot 2024-04-19 at 17.26.25.png


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

jayllo-c commented 7 months ago

Team's Response

Thank you for the report. However, as seen in the textbook, informal usage of descriptions is commonly used. As our team has decided that more precise details were not required, we chose a more informal, and more understandable notation that does not cause any loss of detail but in fact adds on to the understanding of the sequence diagram.

image.png

Duplicate status (if any):

--