search

muller317 / pe

0 stars 0 forks source link

Incorrect example command presented in the user guide #3

Open muller317 opened 1 week ago

muller317 commented 1 week ago

image.png add n\Sam Tan i\T3848559A yg\3 p\81003999 e\samtan@gmail.com a\9 Smith Street \Science is missing the s before /Science, yielding an error message when trying this command

nus-pe-bot commented 1 week ago

Team's Response

Thanks for pointing this out! Our team missed out on this typo in the user guide. But we believe this should be a severity.low bug as this is an example provided for user to refer when the first use the app, and this issue stems from a typo (missing 's') that does not affect the functionality of the product. This example provided is for user to familiarize themselves with the command format, it is unlikely to affect normal operations of the product. And it appears only in very rare situations (first time usage of the product) and causes a minor inconvenience (need to manually debug the format) only. Furthermore our app will display a helper message informing the user that the format is incorrect, hence it will guide user to spot the format error more easily. And in the other sections we do provide enough examples and details (e.g. in UG, help window, and error message) to aid the user in debugging. Hence we believe this could be a severity.low documentation bug. Thanks again for noticing the bug!

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]