search

vimalapugazhan / pe

0 stars 0 forks source link

Warnings could have been paired with examples #16

Open vimalapugazhan opened 5 months ago

vimalapugazhan commented 5 months ago

image.png

Warnings could have been paired with examples of delimiter and explicitly stating what not to do as for a new user this would be confusing

nus-se-script commented 5 months ago

Team's Response

the delimiters were designed by the developers to be extremely unlikely for the users to input. One such example is "|_!#$%_EXPENSEDESCRIPTION|}{%_|:". As such, the developers chose to not include the delimiters as these would confuse the user more.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I agree in the case for delimiters for the files but I feel that the team could have made more effort to ensure that using characters such as "/" in the input would not change the output as "/" is very common character and likely to be used by users. Due to this still being an error on the teams part for neglecting to include the characters that may cause the output to change in the UG, I strongly suggest that it is a documentation bug that should not be overlooked.