nus-pe-bot
commented
3 years ago Team's Response
Thank you for your feedback. We have changed the severity to very low as this is a purely cosmetic bug that does not affect the users understanding of the table of contents or the way the user uses the table of contents.
Items for the Tester to Verify
:question: Issue severity
Team chose [severity.VeryLow]
Originally [severity.Low]
- [x] I disagree
Reason for disagreement: Thank you for your response. I would like to disagree with the downgrading of the severity from LOW to VERY LOW. The inconsistent and inaccurate use of inline code(boxing up) can cause inconveniences to the user/developer reading the DG, as they try to understand how the program works. This is because the use of inline code in this particular context seems to signify that the word inside the inline code is an entity/object within the program, which is a good way to guide the developer's understanding. However, when this use becomes inconsistent, the developer will initially be confused.
In this issue, 'Event' and 'Project' are highlighted using inline code, at that one particular instance. This is in contrast to the other use of the words 'Event' and 'Project', which are not highlighted in such a manner. This would lead the developer to think that the highlighted 'Event' and 'Project' are objects, while the non-highlighted 'Event' and 'Project' words are not actually objects, which is false. This is where confusion may occur. Furthermore, other similar objects, such as 'ToDo' , 'Deadline', 'Contact' , will also be mistaken to not be objects within the program, leading to further confusion.
While this issue may lead to confusion and inconvenience for the developer, it is true that after a while, the developer will eventually identify the inconsistent use of inline code, and be able to properly understand the DG at the end. However, a MINOR INCONVENIENCE would have still been caused to the developer, at the beginning.
Severity.Low states clearly that:
Therefore, I disagree with the downgrading of the severity to VERY LOW, and strongly feel that a severity of LOW would be more appropriate for this particular issue.
In the line: 'Aspect: How to Add a New Event to a Project' , the word Event and Project is boxed up. This behaviour is inconsistent throughout the content page as Event and Project is not boxed up anywhere else on the content page. Also, if boxing up of special words such as 'Event' and 'Project' is done, it should be done for everything consistently, such as 'Contact' , 'Deadline' , 'Todo' , etc. Otherwise, none of the special words should be boxed up in the content page, to make it easier for the user to read the DG.