nus-pe-bot
commented
2 years ago Team's Response
We accept this bug, but following the rubrics regarding the tier of bug severity levels, this issue did not affect usage of the DG. Hence we lowered the suggested severity level.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
DG has unimportant, filler text in the Acknoledgements section
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.
If there are no acknowledgments to be made then it can be indicated as such, or maybe the entire section can be left out. But the default-looking text is maybe not the best way to go.
[original: nus-cs2103-AY2122S1/pe-interim#256] [original labels: severity.VeryLow type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
We accept this bug. Thank you!
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)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue severity
Team chose [severity.VeryLow]
Originally [severity.High]
- [x] I disagree
Reason for disagreement: As mentioned in other issues, severity.VeryLow is for purely cosmetic issue. I realised I put severity.High because I assumed there are acknowledgments but y'all forgot to add it in. I agree with the duplicate of this issue that you could remove the section if there are no acknowledgments as it is very unsightly to have it there, especially with the filler texts. I suggest to lower it to severity.Medium as it can cause occasional confusion and inconvenience to devs reading the DG.
I believe it is important to acknowledge any code or ideas borrowed.