search

samuelory / pe

0 stars 0 forks source link

No example outputs in UG #12

Open samuelory opened 4 months ago

samuelory commented 4 months ago

UG did not give any example outputs, so we dont know what is supposed to show up

nus-se-bot commented 4 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Insufficient output examples throughout 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.

As a user, I would like to see example outputs of all the possible commands for a better understanding of usage.

However, some commands did not show example output ie add , promotion commands.

[original: nus-cs2113-AY2324S2/pe-interim#2549] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

I do agree that we could have furnished the UG with expected outputs, but as per the AB3 reference, expected outputs are not compulsory in the UG.

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: [replace this with your explanation]

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