search

dexter-sim / pe

0 stars 0 forks source link

Module code but different CLI prefix for different commands #9

Open dexter-sim opened 2 years ago

dexter-sim commented 2 years ago

m add c/MODULE_CODE m/MODULE_NAME mc/MODULE_CREDIT

m add c/cs2103t m/software engineering mc/4

This requires module code to have c/.

t add m/MODULE d/DESCRIPTION

t add m/CS2105 d/Assignment 1

This requires module code to have m/.

Expected behaviour is that it should be the same as they are both module codes, like CS2103.

soc-pe-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Inconsistent prefix used

image.png

image.png

in adding a module, m/ was used for module name

image.png

image.png

in adding an exam, m/ was used for module code

image.png

image.png

in adding a task, m/ was used for module code but described as "module"

This inconsistency led to a less pleasant user experience because as a user trying to familiarize oneself with all the different commands and prefixes, the inconsistency led to multiple command errors. Especially since module code is a necessary field to be used in multiple commands, this has hindered the overall enjoyment of using the app.

[original: nus-cs2103-AY2223S1/pe-interim#5363] [original labels: type.FeatureFlaw severity.VeryLow]

Their Response to the 'Original' Bug

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

No details provided by team.

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 severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: No details were provided by the developer team on why this bug report is downgraded to severity.VeryLow.

With more time to think, I feel that this bug could be upgraded to be labelled as severity.Medium. Here is my justification.

image.png

For the commands in module, c/ prefix is used for module code. Whereas for the commands in exam and task, m/ prefix is used for module code. They should all have the same CLI prefix as they refer to the same field.

A very low severity is only for cosmetic problems and this is clearly not a cosmetic problem as having different CLI prefixes directly affects how the user uses the application, which affects usage. Hence, it cannot be labelled as severity.VeryLow.

The different prefix will cause occasional inconvenience to some users if they were to use c/ prefix for exam and task commands, or vice versa. It cannot be expected of users to remember which prefixes are used in which commands when both prefixes refer to the same field. This is because there are no reasoning provided on why c/ is used for one and m/ for the other two, which would not help the user remember which prefix is for which command. From the user's point of view, both c/ and m/ will appear as arbitrary choices. Hence, it is to be expected that some users will occasionally slip up and use the wrong prefix, causing occasional inconveniences where they would have to edit what they have typed in the command box, but they can continue to use the product. Even some experienced users could make these occasional mistakes due to absent-mindedness or carelessness.

It is a flaw that causes occasional inconvenience to some users but they can continue to use the product. Therefore, the bug report qualifies for what is stated in severity.Medium label.