thewongdylan / pe

0 stars 0 forks source link

Incorrect parameter specification for add command #6

Open thewongdylan opened 5 months ago

thewongdylan commented 5 months ago

Description The user input parameter s/Sex is not capitalised in the description for the add command despite it being a required user input.

Expected Capitalised s/SEX is expected

Actual s/Sex is not capitalised Screenshot 2024-04-19 at 4.34.16 PM.png

Reason for severity May affect usage if users are incorrectly informed that this is not a required user input parameter.

nus-pe-script commented 5 months ago

Team's Response

Thank you for feedback. We agree that this is inconsistent formatting on our part, but disagree regarding the severity, as there is no way to interpret this as an optional parametr due to the lack of square brackets. Lack of capitalisation is purely cosmetic, and will not affect the reader's understanding that the sex field is required.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]