search

ngnigel99 / pe

0 stars 0 forks source link

Optional parameters not enclosed in help command #12

Open ngnigel99 opened 2 years ago

ngnigel99 commented 2 years ago

image.png

{} should enclose the dividers too e.g. {-p ...}

nus-se-bot commented 2 years ago

Team's Response

This is a similar issue to #1078 (for UG). To reiterate our point:

The content inside the braces is strictly for parameter. Consider the two examples below:

add task [TITLE] -d [DAY_OF_THE_WEEK] -p {PRIORITY}
add task [TITLE] -d [DAY_OF_THE_WEEK] {-p PRIORITY}

The first line is arguably more readable, and it should be clear enough for everyone to deduce that -p is not needed if PRIORITY is not used.

The 'Original' Bug

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

Optional parameters are not enclosed in command summary

image.png

the {} should enclose the parameters inside too. e.g. {-p pr...}

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

Their Response to the 'Original' Bug

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

The content inside the braces is strictly for parameter. Consider the two examples below:

add task [TITLE] -d [DAY_OF_THE_WEEK] -p {PRIORITY}
add task [TITLE] -d [DAY_OF_THE_WEEK] {-p PRIORITY}

The first line is arguably more readable, and it should be clear enough for everyone to deduce that -p is not needed if PRIORITY is not used.

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.Rejected]

Reason for disagreement: Going by your first statement, -p is considered a parameter as it's part of user input and gives meaning to whatever input follows,

Therefore, since -p is not enclosed in {}, the following should work by the documentation as only PRIORITY is optional.

image.png

However, I see the merit in only enclosing PRIORITY for readability - however, it's much clearer just to block out the entire chunk inclusive of -p, which is one of my considerations for issuing only a LOW severity.

:question: Issue type

Team chose [type.DocumentationBug] Originally [type.FeatureFlaw]

Reason for disagreement: Screenshot is taken from the app, not UG.

:question: Issue severity

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

Reason for disagreement: Since it affects normal usage by the user, it's not VERY LOW - however, it only causes a minor inconvenience, thus LOW.