nus-cs2103-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Long keywords for commands #1579

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

There are some keywords that could have been shortened while still being intuitive enough to understand. For example, Patron could be shorten to "pat" ,book to "bk" and delete to "del". Using vim as a reference, I think the command keywords are longer than they should be. Severity could be medium.


[original: nus-cs2103-AY2122S2/pe-interim#1576] [original labels: severity.Low type.FeatureFlaw]

bingsen0806 commented 2 years ago

Team's Response

Thank you for your opinion. Below are some thoughts from our team that we could discuss about.

Firstly, there is no common consensus among modern software that the first keywords should not be one to two words long. For example, git is arguably the most popular CLI software, but it's commit command (“commit”) is also 6 characters, which has the same number of characters as “delete” (as given in your example)

It is, however, a common consensus among modern software that flags are usually one or two characters (e.g. the -u in git push -u, or the -l in ls -l). Our team has implemented this, as our command flags are only 1 letter (e.g. i/ for ISBN). Hence, our team believes that our commands have met the reasonable expectations of a modern CLI software.

Further shortening of commands might be a nice-to-have feature, but the absence of it does not cause inconvenience. Furthermore, keywords that are too short can also reduce the learnability of the software. Using keywords like “patron add” or “book add” allow the user to associate commands with real-life objects.

Due to the above reasoning, we believe that this should not be a bug.

Duplicate status (if any):

--