search

spencernah / pe

0 stars 0 forks source link

In UG, batching editing contacts feature did not mention about selecting an index greater than list size #17

Open spencernah opened 2 years ago

spencernah commented 2 years ago

Document did not mention that users are not allowed to select an index (SEQ_NO_OF_CONTACT) that is within the list size

nus-pe-script commented 2 years ago

Team's Response

There is already an error message prompting users to enter the correct index. Mentioning in the documentation seems unnecessary since it is likely a typo.

The 'Original' Bug

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

In UG, editing contacts feature did not mention about selecting an index greater than list size

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.

Document did not mention that users are not allowed to select an index (SEQ_NO_OF_CONTACT) that is within the list size

[original: nus-tic4002-AY2122s2/pe-interim#249] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

There is already an error message prompting users to enter the correct index. Mentioning it in the documentation seems unnecessary since it is likely a typo.

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: The other ticket is for edit command but this is for edit -batch command.

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Even though error message is present, the purpose of a UG is to educate users on what the function offers and the limitations/constraints of a function, if any. In other words, the users should know what they can and cannot perform with the function.

Aside from the purpose of UG and from an academic point of view, we can see that this is implemented in AB3 UG even though it is phrased slightly differently. Thus, this is a requirement or baseline of a UG. Please refer to the below screenshot for reference. Screenshots are obtained from AB3 UG (https://se-education.org/addressbook-level3/UserGuide.html)

image.png

image.png

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]