search

nus-cs2103-AY2223S2 / pe-dev-response

1 stars 0 forks source link

DG Lesson Model #2158

Open nus-pe-bot opened 1 year ago

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

Other than the position of this section, the content seems confusing. The UML diagram shows an additional Set class when the description only mentions the Lesson and the name(String).

'contains String representation of the name' is confusing as well, as 'name' can refer to that of the student.

Furthermore, in the model section, the DG constantly references the Person class which I assume to be the people/students. However, now the section mentions a Student class and it is not apparent whether or not they are the same. If not, how would the Student class hold all the other relevant information such as name, email and so on.

[original: nus-cs2103-AY2223S2/pe-interim#1775] [original labels: severity.Medium type.DocumentationBug]

Zhongli5712 commented 1 year ago

Team's Response

No details provided by team.

Duplicate status (if any):

--