search

howtoosee / pe

0 stars 0 forks source link

Optional for DATE not indicated in format #4

Open howtoosee opened 4 years ago

howtoosee commented 4 years ago

Screenshot 2020-11-13 at 16.45.23.jpg

Discrepency in format for DATE which is not put in [ ] but optional.

nus-se-bot commented 3 years ago

Team's Response

This is a minor format mistake in the user guide. The usage of date being optional is explained in the point below the format in the very next line, which can be seen in the screenshot provided. The reason why we have lowered the severity of the bug is because we believe it does not hinder the reader and is a cosmetic bug.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I believe that this is still considered as a documentation error. While it is true that it is explained in the next line that Date is optional, it was also explained at the start of the UG that only parameters in [] are optional. The fact that two lines of contradicting information being so close to each other still may result in misunderstanding and confusion.

Though I agree that the serverity can be lowered, the discrepency is still misleading, hence, the severity should be kept at medium or at least a low.