search

LWS49 / pe

0 stars 0 forks source link

UML diagram for AddCommandParser does not reflect functionality accurately #14

Open LWS49 opened 2 months ago

LWS49 commented 2 months ago

image.png

According to this diagram, if a parameter is invalid, it should always be raised first when it exists in conjunction with the insufficient parameters error.

image.png Even though the name parameter is invalid, the insufficient parameters error is raised first.

nus-se-script commented 2 months ago

Team's Response

The bug is of a similar nature (activity diagram that does not accurately reflect the order in which the program checks)

The 'Original' Bug

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

UML diagram for weight does not reflect functionality

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

If the index is invalid, the Invalid index error should always be raised first based on this diagram.

However, that is not the case here:

image.png

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

Their Response to the 'Original' Bug

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

image.png

This bug only occurs in rare situations when both the index AND the weight are invalid, and only when index is wrong by being higher than the list size. If index is 0 or less, the diagram will be correct.

Considering that the bug only occurs when:

  • The index is greater than the list size
  • The weight entered is also wrong

We find that it is more reasonable to say that it occurs in very rare situations and not occasionally. Furthermore, this only causes a minor inconvenience.

Thus, we have accepted the bug, but downgraded the severity from Medium --> Low.

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: Although these two DG bugs are of a similar nature, they are not duplicates as neither criteria is satisfied for duplicate bugs (refer to screenshot below).

image.png

Both bugs are neither exactly the same, nor can they not be fixed independently.

## :question: Issue type Team chose [`type.DocumentationBug`] Originally [`type.FunctionalityBug`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]