search

shaunlxw / pe

0 stars 0 forks source link

DG model class diagram: missing VersionedAddressBook #21

Open shaunlxw opened 4 months ago

shaunlxw commented 4 months ago

Looking through the code, seems like ModelManager has a field of type VersionedAddressBook. Model class diagram in UG should be updated, and described in text below.

image.png

nus-se-script commented 4 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]

DG link to classes components are not updated

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

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

Their Response to the 'Original' Bug

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

Severity Low since it just a DG bug and causes a minor inconvenience when users want to view the code for the respective classes.

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: Completely different bug.

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** The purpose of the DG is to guide a new developer through the design and codebase. With an erroneous representation of a major component in the app, the reader will eventually face related problems in other sections of the DG (e.g. when they reach the implementation section of the undo/redo section and start wondering where did `VersionedAddressBook` come from since it wasn't mentioned or included in any of the high level models). Hence this bug isn't rare, and brings more than minor inconvenience as it will require the reader to look through the codebase themselves to figure out where `VersionedAddressBook` fits in (i.e. the DG failed its purpose).