Open ngnigel99 opened 2 years ago
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.
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.
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.
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
.
the {} should enclose the parameters inside too. e.g. {-p pr...}