search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Improper class diagram #1301

Open nus-pe-bot opened 5 months ago

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

Class diagram in page 12 should have attributes and method in two different partitions image.png

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

tayponghee commented 5 months ago

Team's Response

image.png

While some of the partitions are attributes and the others are methods, as a developer, it should be evident enough as to which one are attributes and which ones are methods. Moreover, it is of accepted practice, as seen above. The parts of the classes that were omitted are not important for the task at hand.

Duplicate status (if any):

--