search

Statspadders / pe

0 stars 0 forks source link

UG - Add command summary #10

Open Statspadders opened 1 year ago

Statspadders commented 1 year ago

image.png

The example given, will not be allowed in FAid, phone numbers must start with 6, 8 or 9

nus-se-script commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Misleading example

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.

Under Features [i] section,

image.png

However, the program itself does not allowing either p/12341234 or p/56785678. (Phone number need start with 6,8,9)

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

Their Response to the 'Original' Bug

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

This was a typo on our side we meant to have the phone numbers start with 6, 8 or 9

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: It is the same type of bug. But different severity

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** As a user of FAid, I have encountered an issue where following the Add command example provided in the user guide results in an error. This is not simply a typo error, but rather a documentation bug that causes functionality bugs for the user. The user guide implies that the command will add a client to the system, but instead FAid returns an error message. Command examples are crucial in the user guide as they are the first thing users will try out. Therefore, it is essential that they are exhaustively tested to ensure that there are no errors. The current issue not only causes frustration for the user, but it also wastes valuable time as they attempt to troubleshoot the problem. In light of this, I would rate the severity of this issue to be at least **MEDIUM**