nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

DG: Not necessary to show the Packages #2576

Open nus-se-script opened 7 months ago

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


Not necessary to show the packages in UML diagram (i.e java, io) but it is not penalised so alls good!

Screenshot 2024-04-19 at 5.25.41 PM.png


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

ttasnim5 commented 7 months ago

Team's Response

Because there are no other fields for Parser class, we felt the need to be extra specific in how we depicted its class diagram. Additionally, we found it important to clarify our mechanism for reading user input, such as using BufferedReader instead of Scanner.

Duplicate status (if any):

--