pwjj2000 / pe

0 stars 0 forks source link

Some troubleshooting sections in UG does not match the corresponding command placed above it #10

Open pwjj2000 opened 1 year ago

pwjj2000 commented 1 year ago

Since there is a troubleshooting section under each command in the UG, I am assuming that each troubleshooting section is dedicated to the command above it.

However, for commands sort and grade, the troubleshooting sections do not seem to respond to possible issues from their respective commands.

Troubleshooting section below grade:
The section mentions about INDEX parameter even though grade does not utilise it.

image.png

Troubleshooting section below sort:
The section talks about finding a student and correct student's name even though it is not utilised.

image.png

nus-pe-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

UG Troubleshooting format

image.png

It would be better cosmetically to have the Solution on a new line


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

Their Response to the 'Original' Bug

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

Personal stylistic choice

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 think the issue I raised is entirely different from what was indicated as a duplicate. The latter is purely a cosmetic bug, but mine is an issue that the troubleshooting section does not match the command feature.


:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I believe that this is in scope since this section of the UG is delivered under v1.4.


:question: Issue severity

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

Reason for disagreement: The issue I raised is not just a cosmetic bug.