nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

parameter surrounded in brackets = optional in UG, but the actual parameter is not optional #1693

Open nus-se-script opened 6 months ago

nus-se-script commented 6 months ago

image.png for the change currency command, in the UG the currency appears to be optional as it is surrounded in brackets, but it is not optional in the app. While the description says currency can not be null, this formatting is inconsistent with the rest of the UG (as there is a disclaimer in the beginning saying that any parameter in [ ] is optional). image.png


[original: nus-cs2113-AY2324S2/pe-interim#2016] [original labels: severity.Medium type.DocumentationBug]

sweijie24 commented 6 months ago

Team's Response

Issue accepted as a minor typo. With the relevant explanations and details provided on what the feature does, it should be straightforward in the inputs being used to be compulsory. As such, I believe the severity should be slightly lowered to a low.

Duplicate status (if any):

--