search

nus-cs2113-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Short forms of flags are not permitted #682

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

Short forms of flags (such as /c instead of /category) are not permitted, making it inconvenient for the user to type the entire word every time he wants to write a command.

image.png

Additionally, what makes this bug Serrverity.Medium is the fact that trying to add a flag using /d 15-02-2024 does not lead to an error. Hence, the user will most probably assume that the record has been added successfully. But on listing and viewing the added record, we see that the program has disregarded everything after the /d flag and instead used the system date and time and has added to the database. The user is not made aware of this!

[original: nus-cs2113-AY2425S1/pe-interim#555] [original labels: severity.Medium type.FeatureFlaw]

KHsienKit commented 6 days ago

Team's Response

We did not mention anywhere in our UG or help commands that we allow for short form flags Description and Date both starts with the letter d. Using /d thinking it is for the date but not for the description is a user error. Furthermore, we have mentioned in our DG that using "incorrect" flags will not throw an error as our program uses the same philosophy of other CLI programmes where an error is not thrown when an incorrect flag is used

image.png

But we concede that our program could have incorporated the usage of short form flags. That is why we are marking this as NotInScope

Duplicate status (if any):

--