Open officialchengyud opened 2 months ago
This bug is not related to the quality of the documentation because the documentation is still accurate as it is true that the education level cannot contain special characters.
Team chose [response.Rejected
]
Reason for disagreement: I disagree!
How is leaving out information not part of quality of documentation. I have screenshotted below what is counted as potential bugs in the UG.
Whilst you may be correct about the special characters portion, you left out an important information about the format!
How would anyone automatically know that the EDUCATION_LEVEL
should be Letter followed by number
. This is crucial information and will hinder the user.
As such, I disagree.
Overview In the
add
command part of the UG, the constraints say thatFor EDUCATION_LEVEL, the input must not contain special characters.
. However, the actual constraint (when using the actual app) is thatEDUCATION_LEVEL
actually has to be a letter followed by a number.Low severity explanation I would almost catagorise it as a medium because if I only read the UG and not the app, I would not have been able to figure out that the format for
EDUCATION_LEVEL
is letter followed by a number.Screenshot