search

joosxi / pe

0 stars 0 forks source link

Add module command for customised modules do not work #4

Open joosxi opened 1 year ago

joosxi commented 1 year ago

image.png

image.png I tried typing in the exact same command as given in the UG for the addition of a customised module, but a syntax error is returned.

I did not copy and paste directly from the pdf but typed in the command myself

nus-pe-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Mismatch between script and UG

螢幕截圖 2022-11-11 16.43.26.png

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

Their Response to the 'Original' Bug

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

Documentation should be updated to reflect valid module codes instead, hence this is a documentation bug rather than a functionality bug

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.DocumentationBug] Originally [type.FeatureFlaw]

Reason for disagreement: [replace this with your explanation]

:question: Issue severity

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

Reason for disagreement: Agree that it is a documentation bug now that you have explained it, and the command indeed works when module code is between 6-9 characters. However, severity should still be medium as this is not merely a typo or cosmetic issue in the UG that warrants a very low severity.

This incorrect example will cause quite a bit of confusion to users who are just starting to use your app and is following the UG closely to learn how to use it. When they encounter such an error even despite following the UG, they may be discouraged and may not even bother reading the error displayed in the app. In the worst case, they may choose to stop using your product as they feel that it is not functioning properly or is incomplete.

Thus, severity of medium may be more appropriate as user may still continue using the app, but occasional inconvenience will occur whenever they are referring to the user guide to use the app, perhaps due to forgetting how to use it after long periods of not using it.