internityz / pe

0 stars 0 forks source link

Examples in findcheese is repetitive #6

Open internityz opened 3 years ago

internityz commented 3 years ago

Examples are repetitive. It could be summarised in one example by just showing an example that searches multiple different params.

image.png

nus-pe-bot commented 3 years ago

Team's Response

Rejected. The examples given are different and are therefore not repetitive. This does not affect the quality of the documentation. The first example explains the result of multiple parameters and search keys and the 2nd example is a command for the user to try.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: image.png

There are repetitive screenshots and hard to see what's similar and what's different. If there is a need to provide additional examples to show users what command to try, screenshots are not needed as the result will be similar. Other examples can be formatted and shown to users without needing more screenshots


:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Medium]

Reason for disagreement: [replace this with your explanation]