adenteo / pe

0 stars 0 forks source link

Unclear documentation of command usage #17

Open adenteo opened 1 year ago

adenteo commented 1 year ago

The long documentation of add command as add –e EVENTNAME –st STARTTIME –sd STARTDATE –et ENDTIME –ed ENDDATE -v VENUE -r RECURRING TIME is quite difficult to read and follow. I have to read through the entire feature to find out what switch was compulsory, what was not and how to use it.

Perhaps the team can consider Google`s CLI command syntax to better document the usage, such as arrow brackets (<>) for compulsory arguments and square brackets ([]) for optional ones.

nus-se-bot commented 1 year ago

Team's Response

Thank you for pointing this out. We do acknowledge that our commands are hard to read. However, as this is a cosmetic issue, the severity should be listed as VeryLow. Thank you!

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]