search

wubojin / pe

0 stars 0 forks source link

Typo in stk/ prefix #5

Open wubojin opened 2 weeks ago

wubojin commented 2 weeks ago

In command summary, there was a typo, should be stk/ instead of st/

Typo: image.png

Correct: image.png

nus-se-script commented 1 week ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Example given in command summary does not work (add_product)

image.png

steps to repreduce: run command given: add_product n/Tissue Paper st/500 su/Global Produce

expected: product added

actual: Unexpected syntax found. error message as wrong prefix used

image.png

[original: nus-cs2103-AY2425S1/pe-interim#7] [original labels: severity.Low type.DocumentationBug]

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.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Situation is more severe that one can expect. The `help` command only redirects users to the UG and nowhere else. So, users can only solely rely on the UG for command formats. ![image.png](https://raw.githubusercontent.com/wubojin/pe/main/files/307cd154-7a08-40ef-a1f6-fce38d97bb76.png) While admittedly the `stk/` prefix is in the correct format in the main body of the features of the UG. However, it is likely that a user may only view this correct section of the UG once upon first reading. On subsequent access to the UG, users may already have the general idea of what the system can do and simply just want to double check the command format as that may be harder to remember. This is why most of the time, users will be accessing the command format from the Command Summary, which is also where the typo exists. This typo causes inconvenience to users who just want to quickly see the command format without scrolling through the long list of feature descriptions. This is not a rare situation and is quite common, therefore a Medium instead of Low severity.