nus-cs2113-AY2324S1 / pe-dev-response

0 stars 0 forks source link

\s crashes the program - UG wrote this #597

Open nus-pe-bot opened 12 months ago

nus-pe-bot commented 12 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


Screenshot 2023-11-17 at 5.32.57 PM.png

Screenshot 2023-11-17 at 5.32.07 PM.png

In the first one, i added apple pie correctly with /s. However, writing \s crashes the program.

Since this is incorrect format, it should be handled properly. Think it could fall under the error of tag taking in nonvalid numbers/letters which has been raised. I am classifying it as documentation bug instead because UG instructions aren't clear. From the title, users might use \s instead, and crash the program. Perhaps you could just modify the title of that instruction properly to say s/.


[original: nus-cs2113-AY2324S1/pe-interim#493] [original labels: severity.High type.DocumentationBug]

kaijie0102 commented 12 months ago

Team's Response

It was indeed a fatal typo. However, we feel that it is of low severity as it is very rare for users to face this problem

Because 1) we included the correct way to input steps everywhere else of the document (except this one instance)

image.png

image.png

2) the example shown was correct

image.png

image.png

image.png

Hence, we expect that almost all users will not face this issue. However, it is indeed a bug, hence we accept it :)

Duplicate status (if any):

--