search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Error in Developer Guide Model component section. #2545

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.

Comparing the code for Person and the diagram shown in the Developer Guide, the diagram is inaccurate.

image.png

image.png

For example, implements Identifiable is not shown, while the category types should be shown as an enumeration instead. Below are some examples from the textbook.

image.png

image.png

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

bachletuankhai commented 5 months ago

Team's Response

No details provided by team.

Duplicate status (if any):

--