search

ChocoRagdoll / pe

0 stars 0 forks source link

Not enough examples for the add contact command #9

Open ChocoRagdoll opened 4 months ago

ChocoRagdoll commented 4 months ago

image.png

The examples provided are generally not enough.

For example, for the add contact command, as a user, I would like to see more commands demonstrating that the t/ and g/ fields are optional. Currently, only one example with every parameter is provided.

image.png

nus-pe-script commented 4 months ago

Team's Response

Hi, we believe that the number of examples is appropriate and adding any more would simply clutter the UG since the base of the command would be the same. We have also mentioned in the UG that parameters wrapped with square brackets are optional arguments, so user can extrapolate this to exclude if needed. Furthermore, this is an overview, and for more information, the user can visit the add command section.

In addition, the CS2103T website also says "These are considered UG bugs (if they hinder the reader)", which we believe it doesn't since there's sufficient information for usage.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As a user I may refer to the command summary section when I want to omit all the details and only focusing on the formats of the commands, so it would be essential to include at least the basic examples for gthe users easy reference, instead of 1 example for each of the command. 2 or 3 examples should be sufficient amnd necessary for some commands that have different behaviors. i do agree that the severity should be low.

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]