search

narwhalsilent / pe

0 stars 0 forks source link

Inconsistent usage of `/id` in command format #6

Open narwhalsilent opened 4 months ago

narwhalsilent commented 4 months ago

Commands like delete requires /id flag before inputting id.

image.png

However, the edit command does not require the flag.

image.png

This can be confusing and lead to more errors in executing commands.

Improvement: Add /id for edit command.

nus-pe-bot commented 4 months ago

Team's Response

This is not a bug or feature flaw.

We took into account that since ID is our unique identifier, we would simple use that directly in the edit command without the /id portion so that users can enter the edit command faster.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I agree with the team that it is reasonable to leave out the /id prefix if the ID is used as the unique identifier of persons.

However, if such a principle were in place, the same should apply for the delete command, and even the add command too.

On the contrary, /id prefix is compulsory in delete and add commands.

The original bug precisely concerns the inconsistency in how the prefix /id is used.

However, as indicated below, I agree that this bug is a feature flaw and not a functionality bug, because the application behaves correctly according to UG.

## :question: Issue type Team chose [`type.FeatureFlaw`] Originally [`type.FunctionalityBug`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** This is not a `severity.VeryLow` bug as it is not purely cosmetic. Because some commands require the `/id` prefix and some don't, and there is no leeway for accommodation, the user might misremember which commands require it and which don't, which impedes usage. However, this inconvenience is easily fixable by following the error message to include or delete the `/id` prefix. Hence it is of `severity.Low`.