search

shawnpong / pe

0 stars 0 forks source link

Documentation UG "«««< HEAD" #5

Open shawnpong opened 7 months ago

shawnpong commented 7 months ago

image.png Documentation for UG has random "«««< HEAD" in exit description, no idea what this means?

nus-pe-script commented 7 months ago

Team's Response

Unfortunate typo

The 'Original' Bug

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

Bold character at wrong place.

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 per title

image.png

[original: nus-cs2113-AY2324S2/pe-interim#962] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

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

image.png The formatting errors, typos and unnecessary comments within our documents are purely cosmetic errors and therefore should be deemed as very low severity.

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: I disagree with this as this bug is not merely a cosmetic bug, such as that of bolding characters at wrong place. This bug involves wrong words/symbols being placed in the description of your exit command. This is very misleading and did cause me to spend some time to figure out what was going on with this description.