search

tanjiaxian99 / pe

0 stars 0 forks source link

Hard to understand the description of `reminder` command #20

Open tanjiaxian99 opened 2 years ago

tanjiaxian99 commented 2 years ago

The description of the reminder command is as follows: "Displays the current number of days prior to the date of tasks for them to be considered due soon." This sentence was rather difficult to understand, and it was only after looking at the example of reminder -s 10 did I recognise what the command was meant to do.

nus-pe-bot commented 2 years ago

Team's Response

We have already revised the wording of this instruction to make it as simple to understand based on suggestions given in the PE dry run. The example of reminder -s 10 is given after, precisely to help readers to better understand the instruction.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The example for reminder -s 10 is a different command format from reminder. Hence, it doesn't make sense to let users figure out the function of reminder from reminder -s 10. Further, if the example of reminder -s 10 is necessary to help readers better understand the instruction, it only shows how ineffective the original wording for the explanation of reminder was.

:question: Issue severity

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

Reason for disagreement: Based on my response above, this causes a minor inconvenience to users who are reading the UG for the first time and thus warrants it as a low severity bug.