tayponghee / pe

0 stars 0 forks source link

Extraneous bullet point in the list in DG #13

Open tayponghee opened 2 months ago

tayponghee commented 2 months ago

image.png

the line starting from defined should be part of the line above, and not a new bullet point

nus-se-script commented 2 months ago

Team's Response

Thanks for bringing that up, this was indeed an oversight on our part! Duplicate of #471.

The 'Original' Bug

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

DG BookMainClass empty bullet point

image.png

the bullet point after author is empty


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

Their Response to the 'Original' Bug

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

Thanks for bringing that up, this was indeed an oversight on our part!

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: While it has to do with bullet points, it is not necessarily a duplicate, as they are different parts of the DG. Hence, I disagree that it is a duplicate bug.


## :question: Issue type Team chose [`type.FeatureFlaw`] Originally [`type.DocumentationBug`] - [x] I disagree **Reason for disagreement:** Cosmetic errors in the DG, such as typos, are documentation errors and not feature flaws. In the section under documentation bugs, the following is stated: ![image.png](https://raw.githubusercontent.com/tayponghee/pe/main/files/9cae2092-04cc-431a-b2a1-036af6b88bc8.png) Hence, I would like to affirm that the bug should be a documentation bug and not a feature flaw.