search

audipras / pe

0 stars 0 forks source link

Using snake-case for command words inhibits productivity #2

Open audipras opened 1 week ago

audipras commented 1 week ago

It's not mentioned anywhere in the documentation that command words are case sensitive. Furthermore, having to adhere to the case-sensitiveness of the command words (especially because they use snake-case and are not all lowercase) makes typing the commands noticeably slower.

Example screenshot below:

Lowercase command word: image.png

Uppercase command word:

image.png

soc-pe-bot commented 3 days ago

Team's Response

Thank you for your suggestion. Our commands use camel case, not snake case. The exact usage was clearly stated in our user guide.

Regarding your comment on the case sensitivity of commands, our decision to use camel case for two-word commands was guided by considerations for user readability and clarity. We believe commands like addShortCut and listOrder are more intuitive for users to understand and use. That said, we acknowledge the minor inconvenience caused by case sensitivity and have categorised this issue as low severity.

We also recognise the potential benefit of making commands case-insensitive to further optimise the system. As such, we have placed it under NotInScope.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: This shouldn't be NotInScope since it wouldn't take take "much additional effort" to implement (as mentioned in the textbook). Simply adding a .toLowerCase() method to the parsers ensures this problem is fixed.

image.png

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I disagree that it is severity low, since it affects almost every user that uses the application (most users will be using commands with camelcase at some point when using the app). Not only is it a minor inconvenience when you're typing the command like normal, it also takes up a lot of time if the user makes a mistake in capitalisation (e.g. listShortcut vs listShortCut). Although readability and clarity is a valid concern, the user should have adequately familiarised themselves with the application after a few uses. In a fast-paced restaurant environment, speed and usability should be the primary concern. Therefore, I feel that the severity should remain a medium.