shashahchk / pe

0 stars 0 forks source link

Unclear and confusing command message #3

Open shashahchk opened 8 months ago

shashahchk commented 8 months ago

image.png

Steps to reproduce:

  1. enter "add-a"

I believe the formatting of this message can be better. add-a: Adds an assignment to the app. Parameters: n/NAME e/DEADLINE IN YYYY-MM-DD [HH:mm] FORMAT [d/DESCRIPTION][s/STATUS ] [p/PLAN TO FINISH BY IN YYYY-MM-DD [HH:mm] FORMAT] [t/TAG]

The "[ ]" is used inconsistently. For example, in entering field "n/NAME", no "[]" is used, but for "[d/DESCRIPTION]", the "[]" is being used. This can cause confusion in how to enter the command correctly for users. Considering that this is the most common and fundamental command, it may be categorised as medium severity. However, considering that the UG provides instructions, this can be considered low severity instead.

nus-pe-script commented 8 months ago

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

The square brackets [] means that a parameter is optional and can be omitted. n/NAME has no square brackets because it is a mandatory parameter.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your reason]