seanleong339 / pe

0 stars 0 forks source link

Storage component UML diagram missing classes #11

Open seanleong339 opened 2 years ago

seanleong339 commented 2 years ago

The storage component UML diagram only shows JsonSerializableAddressBook and JsonAdaptedPerson. However in the storage component of the code, there are multiple other storage classes like JsonSerializableTaskBook, and JsonTaskBookStorage. Hence the current diagram is misleading to the reader as it does not include all the classes used at a single level, e.g including JsonSerializableAddressBook but not JsonSerializableTaskBook.

image.png

nus-pe-script commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Storage class diagram does not contain information regarding Tasks and Schedule

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.


image.png

The Storage class diagram does not contain information regarding Tasks. Since Tasks are an important part of the application and are saved through the Storage class, this should be included in the details of the Storage class diagram.


[original: nus-cs2103-AY2122S2/pe-interim#3178] [original labels: severity.Medium 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: [replace this with your explanation]