nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Inconsistency in parameters of add delivery #2814

Open nus-se-script opened 1 week ago

nus-se-script commented 1 week ago

Screenshot 2024-11-15 at 4.59.19 PM.png All other parameters have the phrase 'cannot be blank' except for product although product cannot be blank. Should the phrase 'cannot be blank' be added for product as well for consistency such that the user knows all parameters cannot be blank?


[original: nus-cs2103-AY2425S1/pe-interim#3844] [original labels: severity.Low type.DocumentationBug]

CJianzhi commented 6 days ago

Team's Response

Thank you for pointing that out, we understand where you are coming from in terms of being consistent in the user guide but we omitted the "cannot be blank" phrase because we have already included the description "It must be alphanumeric, only contain between 1 and 50 (inclusive) characters, and spaces are also allowed" for the pro/PRODUCT parameter.

The sentence quoted above informs the user explicitly that there must be at least one character provided for the pro/PRODUCT parameter. Thus we believe that this inconsistency created by excluding the "cannot be blank" phrase is not a bug as it would not affect the user's understanding and use of the add delivery command.

(taken from PE grading section of course website) Screenshot 2024-11-17 at 11.54.37 PM.png

Duplicate status (if any):

--