wz27 / pe

0 stars 0 forks source link

'No clashing classes allowed' is not stated in addclass in UG #12

Open wz27 opened 3 years ago

wz27 commented 3 years ago

The important information that any classes that clash in timing with another class is not accepted is stated in editclass section in UG but not in addclass section in UG.

image.png

image.png

nus-se-bot commented 3 years ago

Team's Response

It is fairly intuitive when looking at the Timetable UI and the correct error message is shown when you add a clash in class timing anyway. Severity should be VeryLow.

The 'Original' Bug

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

UG did not mention about what happen if there is a clash in timing

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.


In the UG, under addclass feature, there is no mention of what will happen if the user tries to add a class with conflicting class timing with other current classes.

image.png


[original: nus-cs2103-AY2122S1/pe-interim#5088] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

We felt that this is not a very important point as the app will throw an error when the user tries to add a class with a clash in timing. Additionally, according to the picture below, it is not needed to be mentioned if the command throws an error for the invalid input.

Screenshot 2021-11-14 at 1.15.51 AM.png

Furthermore, it has been stated in the UG already under edit class command.

Screenshot 2021-11-14 at 1.14.08 AM.png

It is fairly intuitive when looking at the Timetable UI and the correct error message is shown when you add a clash in class timing anyway. Therefore Severity should be VeryLow.

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: The team claims that "It is fairly intuitive when looking at the Timetable UI and the correct error message is shown when you add a clash in class timing anyway." In that case, this behavior should also not be mentioned under editclass in the UG, but it is present. This is important information that, while rarely, will affect usage of the app by users. Reading the UG in the way that the team has suggested possibly leads to the reader's conclusion that duplicate classes can be added using addclass, but classes cannot be edited to become duplicates using editclass.