search

geraldneo567 / pe

0 stars 0 forks source link

DG: Error in header #21

Open geraldneo567 opened 2 years ago

geraldneo567 commented 2 years ago

Cons part should not be a header. Unnecessarily attention-catching and also appears in the table of contents as a result.

image.png

image.png

nus-pe-script 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]

Wrong format in DG

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.

image.png

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

Their Response to the 'Original' Bug

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

Please provide some explanation but good spot.

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: [replace this with your explanation]

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: severity.VeryLow should be relating to minor typos/cosmetic issues (see the numerous other VeryLow bugs for example, e.g. grammatical errors). However I would say this is far from minor as not only does it confuse the reader unnecessarily and divert attention, but also creates an additional entry in the table of contents which means a totally different part of the UG is impacted. Thus I believe it is not right to downgrade the severity from Low to VeryLow as this would imply this holds error the same weight as spelling 1 word wrongly, for example. I also notice that the team has downgraded a large portion of severity amongst accepted bugs which I think is not graceful, since some of them clearly go beyond cosmetic issues.