search

Yiheng0410 / pe

0 stars 0 forks source link

add command in the UG #3

Open Yiheng0410 opened 3 years ago

Yiheng0410 commented 3 years ago

First, in the example, the last bullet point is not consistent with the first two.

Second, the add does not mention clearly the g/[GROUP] command when add a new person.

The app allows multiple g/ when add a new person, but only takes the first g/ and ignore the rest g/. e.g the first group name is not existed, it will take the second group name if the second one is a valid group name.

Such restriction should be mentioned clearly in the UG for user to follow the command rather than let the user to trial and error the command.

Screenshot 2021-04-16 at 7.48.09 PM.png

nus-pe-bot commented 3 years ago

Team's Response

The duplicated bullet point is accepted, but the second point has been explained in the following section in the UG:

image.png

The 'Original' Bug

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

Information not enough about add command in the UG.

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.

1, dose not mention what fields are compulsory/optional. 2, dose not mention the order of each filed is not fixed. 3, dose not explain the g/GROUP command clearly. e.g. if multiple groups is allowed? what happens if user enter mutile g/GROUP commands.

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

Their Response to the 'Original' Bug

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

The add command format has been following the "Notes about the command format" as shown below:

image.png

image.png

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's more about the group command

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The dev team's reply didn't mention the format of the sub point, whether it is a typo or sub point? But it don't look like a sub point at all.

Although the UG mentioned the group command in the add command, but it is not clear enough to tell user how to use the group command, e.g. can use add multiple groups to a person? If can not, what if the user enter multiple groups, what will happened.