nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

wrong use of capitalisation in assign command #2496

Open nus-se-script opened 10 months ago

nus-se-script commented 10 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


Since except for NAME, all parameters are case sensitive, assigning department here used cardiology but at the appendix used Cardiology, where c is in caps. So which standard should we follow? with caps or without caps?

image.png

image.png


[original: nus-cs2103-AY2324S1/pe-interim#3686] [original labels: type.DocumentationBug severity.VeryLow]

AaronJT1 commented 10 months ago

Team's Response

Thanks for raising this issue!

However, we believe that we have stated clearly under the 'Features' section of our User Guide that all parameters except for name are case-insensitive (please see the screenshot below).

Screenshot 2023-11-20 at 7.26.51 PM.png

Therefore, both cardiology and Cardiology are accepted. We feel like it is unnecessary to provide all possible cases for the capitalization of department inputs in the table, which is why we only provided one example of acceptable input(s) and believe that it would not cause any ambiguity. As for the example, it was not capitalized precisely because we wanted to showcase case-insensitivity of the department input.

Duplicate status (if any):

--