vishandi / pe

0 stars 0 forks source link

Inconsistent UG regarding t/BREED #4

Open vishandi opened 2 years ago

vishandi commented 2 years ago

image.png
The second point (highlighted in blue) says that it can only accept one breed, however, the fourth point (highlighted in yellow) says that you can remove all the breeds associated to that pet, which implies a pet can have more than one breeds.

nus-pe-script commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Different use of breed and tag between UG and DG

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.


In the UG, t/ is used to indicate a dog breed. It is referred to as the 'breed' field and never a tag field. In the DG, it is only referred to as a 'Tag' and no mention is made that this refers to the breed of the dog. It seems to be a relic of AB3, but it should probably be made more consistent. If Tag is meant to represent the breed of a dog, it makes sense to at least mention that in the DG if not change the name of the class itself.


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

Their Response to the 'Original' Bug

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

For the user guide, it is meant for the user as such we use 'breed' as it is more reader-focused for the target audience. However, in the DG, since the developer is exposed to the inner workings of the application, it makes sense to use Tag in the DG.

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: There is no correlation at all between my issue and the said original issue. In fact, I didn't even compare the UG with DG, as what the problem is in the original issue. My issue is in the wordings of "You can also remove all the breeds associated to the pet", in which this implies that a pet could have more than one breed, which is not the case.


:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: There is no correlation at all between my issue and the said original issue. In fact, I didn't even compare the UG with DG, as what the problem is in the original issue. My issue is in the wordings of "You can also remove all the breeds associated to the pet", in which this implies that a pet could have more than one breed, which is not the case. Which means this is still an issue.


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]