search

Hazel1603 / pe

0 stars 0 forks source link

Model Component not updated #27

Open Hazel1603 opened 3 years ago

Hazel1603 commented 3 years ago

Retains the entire section of AB3... even the notes are not modified. And the diagram is clearly missing Module and Meeting entities.

nus-se-bot commented 3 years ago

Team's Response

The diagram is used to show a pattern used when designing the storage component rather than the entirety of the storage component. The addressbook is meant to be an example. But we understand that it may lead to a misunderstanding so we could have been more explicit.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Low] Originally [severity.High]

Reason for disagreement: Even if the diagram 'is used to show a pattern when designing a (model) component', I think that your new entities should be included. Especially since they are new, all the more they should be included to allow users to have a better understanding of how they interact as part of your code. There is also no additional elaboration or mention of meetings and modules in the description below, which should definitely be present if you choose not to modify the diagram. This hinders the quality of documentation as you omitted important information and painted a somewhat incomplete picture of your model component.