nus-cs2103-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Forgot to write TOC or should have removed entirely if not intending to write #655

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years ago

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.


6E453DCF-E277-4270-95AB-30FB60085CDA_4_5005_c.jpeg

Severity verylow as i see this as cosmetic although should have removed if not intending to write. However the addition of TOC could have helped the reader to navigate through the DG easily especially if it is their first time reading. Severity should have been low as without TOC, it is difficult for first timer to navigate to and have an overview of the DG.


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

ianfromdover commented 2 years ago

Team's Response

We are marking this a duplicate of #2918, as both issues (missing ToC in UG, and in DG) are caused by the same Markdown parser misconfiguration; as a result, it is impossible to rectify one issue without rectifying the other.

This is also substantiated by the PE guidelines:

What bugs can be considered duplicates? [...] Only the following cases can be considered duplicates:
(a) The exact same bug reported multiple times.
(b) Multiple buggy behaviors that are actually caused by the same defect and cannot be fixed independently (i.e., fixing one fixes the others automatically).

Duplicate status (if any):

Duplicate of #2918