mesyeux / pe

0 stars 0 forks source link

Unnecessary repetitions of example commands #11

Open mesyeux opened 3 years ago

mesyeux commented 3 years ago

Screenshot 2021-04-16 152152.png

One or two would have sufficed, this many examples with a large chunk of text might be confusing to readers.

nus-pe-bot commented 3 years ago

Team's Response

First of all, severity is downgraded from medium to low because the examples are unlikely to affect the normal reading of the UG and it only causes minor inconvenience.

The team is rejecting this issue because our intention was to show concrete examples of the possible variations of the command.

The first example demonstrates an add command with all the compulsory fields. The second example demonstrates an add command with multiple tags. The third example demonstrates an add command with optional fields.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: If it was to illustrate different things, perhaps you could've specified what it was trying to do. As a reader, I got quite confused seeing the chunk of commands with so many different command words.


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]