search

chewterence / pe

0 stars 0 forks source link

DG inconsistent formatting #16

Open chewterence opened 3 years ago

chewterence commented 3 years ago

"object is created and it calls" is styled as a code while it should not be the case.

image.png

nus-pe-bot commented 3 years ago

Team's Response

No response provided.

The 'Original' Bug

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

Strange markdown formatting

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.

Markdown a little wonky here that makes this section a bit messy.

image.png

[original: nus-cs2103-AY2021S2/pe-interim#2627] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

Formatting issue in markdown due to extra space in inverted commas. Assigned very low as it is a typo, does not affect usage at all.

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: Thank you for the response.

I would like to highlight that while it might be typo, the potential confusion caused here is more than just a regular typo (words spelt wrongly). These texts appear in code boxes which might cause the reader to think if this is some part of the code, or perhaps some important technical detail.