search

kohkaijie / pe

0 stars 0 forks source link

Inconsistent use of full stops #9

Open kohkaijie opened 11 months ago

kohkaijie commented 11 months ago

There are instances within the DG where some sentences use full stops while others do not. It should be consistent throughout the document.

image.png

image.png

nus-pe-script commented 11 months ago

Team's Response

Thank you for the observation.

We agree that it requires a sharp eyesight and an attention for detail to be able to spot the absence of full stops.

However, we disagree that this is a valid bug, for the following reasons:

  1. There are no requirements for the use of full stops in Glossary.

  2. The absence and presence of full stops at the end of every definition in Glossary does not hinder the reader, and it does not affect the readability of the Glossary section, in any way.

We would like to bring your attention to the CS2103T course website, which states that a documentation bug in DG/ UG is only valid if it hinders the reader.

Screenshot 2023-11-20 at 2.47.23 AM.png

And specifically, for the Glossary section,

Screenshot 2023-11-20 at 2.40.32 AM.png

We do not think that full stops are important terms which are left out.

Therefore, we are rejecting this bug.

Thank you.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]