yucongkoo / pe

0 stars 0 forks source link

Bug in use case 3 - included internal behaviour #22

Open yucongkoo opened 11 months ago

yucongkoo commented 11 months ago

Note the following sentence in the use case:

System updates with the preferred form of contact.

Screenshot 2023-11-17 at 5.33.12 PM.png

This is an internal behaviour and should not be included in use cases.

nus-se-script commented 11 months ago

Team's Response

It is not an implementation detail. This is just stating what the application will do and not providing the exact details to how the preferred contact command is being added.

The 'Original' Bug

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

Bug in use case 7 - included internal behaviours

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.


Notice the following sentence in use case 7:

InsuraHub deletes the person

Screenshot 2023-11-17 at 5.36.42 PM.png

This is an internal behaviour and should not be included in use cases.


[original: nus-cs2103-AY2324S1/pe-interim#3107] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

It is not an implementation detail. This is just stating what the application will do and not providing the exact details to how it is being deleted.

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: Quoting from the course website PE instructions: Screenshot 2023-11-21 at 12.55.10 PM.png

These are different use cases, and hence can be fixed individually. They are somewhat similar to the multiple typos issue. Hence, I don't think this should be marked as a duplicate bug to the original bug.


## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** > It is not an implementation detail.This is just stating what the application will do and not providing the exact details to how it is being deleted. I do agree with you that this is not an implementation detail, however, I did not say that it is an implementation detail. Rather, I said that it is an **internal** detail. More specifically justifying my statement, the system updating itself is an internal detail which is not externally visible by the user. This case is somewhat similar to the following counter-example provided in the textbook, where the system does some internal action(saving a file to cache). ![Screenshot 2023-11-21 at 1.29.44 PM.png](https://raw.githubusercontent.com/yucongkoo/pe/main/files/68a24e85-89ce-47ce-a5f1-7114f9aab5af.png)
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** I do not think this is an cosmetic issue, rather, it is including internal details that should not be included in use cases(so technically this use case is not a correct use case)