JingHaoooo / pe

0 stars 0 forks source link

Command is case sensitive but was not stated on the User Guide #2

Open JingHaoooo opened 6 months ago

JingHaoooo commented 6 months ago

image.png

For example: using the command 'help' does work but using the command "HELP" shows the following error.

nus-pe-bot commented 5 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Case-sensitive commands

All commands are case-sensitive, making it harder to type.


[original: nus-cs2113-AY2324S2/pe-interim#2085] [original labels: severity.Low type.FeatureFlaw]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

The CLI application target audience is for fast and accurate typer. The use of case-sensitive commands was to ensure that the commands to input will be short but clear especially when there are multiple words chained together. Eg, listEverythingAll. In fact, we chose to use camelCase for the commands so that it is easier to use.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


## :question: Issue type Team chose [`type.FeatureFlaw`] Originally [`type.DocumentationBug`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** ![image.png](https://raw.githubusercontent.com/JingHaoooo/pe/main/files/330e5195-9399-41a6-94e3-1a5b153e55e5.png) While I acknowledge that this can be identified as a feature flaw, the fact that they did not mention commands being case-sensitive in the user guide makes it a documentation bug too. Following the bug severity labels provided, having case-sensitive commands would fall under medium severity as it does causes occasional inconveniences to users but they can still continue to use the product. Take for example, in order to use the application, the users must be very mindful of the camelCase commands that they have in order for the command to work. This would greatly inconvenient the users as a simple mistake would render the command as unknown. In addition, by enforcing camelCase for their commands, it makes it difficult for users to use their application. The use of camelCase was unnecessary as adds complexity rather than clarity, as well as difficulty rather than ease to use, which was completely opposite of what the team have claimed. To add on, the following is a snippet of how unnecessarily complicated commands could be identified as a bug. ![image.png](https://raw.githubusercontent.com/JingHaoooo/pe/main/files/d50e33e7-c289-4aca-931f-763bf143a283.png)