search

rohit0718 / pe

0 stars 0 forks source link

Inconsistent colon formatting #15

Open rohit0718 opened 3 years ago

rohit0718 commented 3 years ago

May want to standardise the formatting of the colons in the header (space vs no space before colon).

image.png

vs.

image.png

nus-pe-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Inconsistent syntax 'e.g' vs 'e.g.'

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

As shown below.

image.png

[original: nus-cs2103-AY2122S1/pe-interim#2693] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thank you for pointing that out. However, as it does not affect user readability or hinder understanding, we do not feel that it would classify as a bug especially since it is not command/feature related.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: Not sure how the incorrect colon formatting here has anything to do with the inconsistent syntax of e.g. as stated by the team.

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: This categorizes under the "Minor typos and grammar errors" segment of "Documentation bugs" as explicitly stated in the module website.