search

whoisjunhong / pe

0 stars 0 forks source link

Add command examples do not provide any explanations, but the edit command does. #11

Open whoisjunhong opened 2 years ago

whoisjunhong commented 2 years ago

Context: Add and edit examples varies, edit states the explanation while add just shows the command

image.png

image.png

nus-se-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]

Adding a record: Example 1 provides explanation while example 2 does not

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.

image.png

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

Their Response to the 'Original' Bug

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

we don't see the need to explain the same thing twice. It is self-explanatory.

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: Different issue, this issue states that there were not even an explanation for add client (add -c). While the other has at least one explanation for add record (add -r).

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Ambiguous examples without explanation, especially with adding client being the most cruicial part of your application. Already set it as "Very Low" since it is just lacking an explanation to aide the user in thier experience of using the application while reading your UG