nus-se-bot
commented
3 years ago Team's Response
Rejected this as one cannot read the format in isolation. Details on how the command works is given the whole section. That is just the format, users should read the whole section to understand fully how the command works. Moreover, the format shows "NEW_DESCRIPTION" which shows that the description is the new part to be editted in the comment and it is right below ( in the tip box) that the date and title cannot be edited.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: The team's response seem to suggest that there is a discrepancy in the format and the tip box, and that this discrepancy should be acceptable because one should "read the format in isolation". The problem here is that there is a discrepancy, and it does lead to confusion. This does not address the issue of documentation, unfortunately. I have to reject their response.
:question: Issue severity
Team chose [severity.Low]
Originally [severity.Medium]
- [x] I disagree
Reason for disagreement: I stand by the medium severity because such a discrepancy leads to user's confusion. I myself am unsure whether it is a mistake that the format and tip box do not concur.
There are 3 parts to this issue.
Noticed in the user guide, it says that "Only description of comments can be edited. Title and Date cannot be edited." However, based on the format of the command, it seems to imply that title and date can be edited. As such, there is a discrepancy.