ymirmeddeb / pe

0 stars 0 forks source link

no error message examples in UG #7

Open ymirmeddeb opened 2 months ago

ymirmeddeb commented 2 months ago

the UG has to visualisation of the customised error messages that might be tied to certain commands. having error examples lets the user know what to expect. here is an example:

Screenshot 2024-04-19 at 17.32.05.png

in this picture, you can see that a negative integer and an integer over 2147483647 and a non integer all have different error messages. this is not mentioned in the UG

soc-se-bot commented 2 months ago

Team's Response

Our user guide only aims to show valid commands instead of invalid commands as a single command can have many different error messages. If we were to include all of them, it would make our user guide more cluttered and reduce readability.

We also chose not to include invalid commands as the user guide serves as a reference for the user to copy and paste commands. If we include too many invalid commands, it might confuse the user as the user would have to sieve through a sea of invalid commands just to find a valid command.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]