search

m1oojv / pe

0 stars 0 forks source link

Inconsistent use of zero or 0 #38

Open m1oojv opened 8 months ago

m1oojv commented 8 months ago

Screenshot 2023-11-17 at 5.40.10 PM.png

nus-se-bot commented 7 months ago

Team's Response

We don't see it as a problem since it is unlikely that it will hinder the reader.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Screenshot 2023-11-21 at 3.48.49 PM.png

While I acknowledge the team's perspective that the inconsistent use of 'zero' and '0' in our documentation is unlikely to significantly hinder the reader, I must respectfully disagree with the decision to reject this as a bug. My agreement with the classification of this issue as severity.veryLow is based on the recognition that it is indeed a cosmetic issue. However, it's important to note that even cosmetic issues can and often do qualify as bugs that warrant correction.

The module website’s definition of Documentation bugs of severity veryLow explicitly includes 'purely cosmetic' issues like typos and inconsistencies. Therefore, the inconsistency in the use of 'zero' or '0' falls squarely within this category. The essence of technical documentation lies not only in conveying information accurately but also in maintaining a high standard of consistency and professionalism. Inconsistencies, no matter how seemingly minor, can detract from the overall quality and professionalism of the document.

In conclusion, while this issue may not drastically hinder the reader's understanding, it is nonetheless a bug that needs to be addressed. Therefore, I respectfully insist that this issue be acknowledged as a documentation bug and addressed accordingly.

Side note: I feel this is a deliberate attempt to reject an issue with the hopes that the tester doesn't (or forgets to) disagree since it is obviously a cosmetic bug and fits with the rubrics that the teaching team has provided.