search

yongkotaro / pe

0 stars 0 forks source link

Missing the `comments` in Person #14

Open yongkotaro opened 6 months ago

yongkotaro commented 6 months ago

image.png

Maybe could include how Person can have a comment as UG states that comments can be added to a person.

nus-se-script commented 6 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Error in Developer Guide Model component section.

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]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

No details provided by team.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: image.png

As Comment is one of the fields of a Person, I feel it should be included for a clearer understanding.