nus-cs2103-AY2223S2 / pe-dev-response

1 stars 0 forks source link

Model component class diagram is messy and incorrect multiplicity for Tag #3839

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.


image.png

Model component's class diagram has intersecting association lines as shown above. And the multiplicity of the Tag class should be * since cards need not have tags (observed when testing app) and can have multiple tags.


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

ruiyigan commented 1 year ago

Team's Response

Since the report contains multiple bugs, we will be addressing the more contentious issue out of the two which is

the multiplicity of the Tag class should be * since cards need not have tags (observed when testing app) and can have multiple tags,

We like to point out that this is not a bug and is simply the way we implemented Tag for Card. Each card needs to have a tag hence, the multiplicity of 1. This is consistent with how we explained the Card object, as seen in the screenshot below (taken from our DG).

The user seemingly doesn't have to tag a card because cards initialized without tags will be tagged as untagged in the "backend" of our application. This is a design consideration as we don't want the user to type untagged for every card that they don't want to tag.

Furthermore, each card can have 1 tag only (not multiple as explained in our DG).

Screenshot 2023-04-16 at 17.10.27.png

Duplicate status (if any):

--