search

qinxutan / pe

0 stars 0 forks source link

Prerequisites for find command not stated v clearly #6

Open qinxutan opened 2 months ago

qinxutan commented 2 months ago

In the UG and DG, for the find command, it is not stated very clearly that a class has to be selected before finding a student.

Expected: student to be returned when enter find command

Actual:

898118DE-B83A-41D0-8160-ACA55355C77D.jpeg

Steps to reproduce: edit the ug and dg to state the prerequisite for users to select class before finding students

nus-se-bot commented 2 months ago

Team's Response

image.png

It is stated here in the UG. Arguably, this is not required in the DG as this is extremely low hanging fruit that a developer should know. Furthermore, find is in the same class of function as all the other commands (i.e. Working with your class commands), this should be patently obvious. In the DG, UC-05, UC-06, UC-07, UC-08, UC-09, UC-10 all remind the user to select a class before performing similar class commands.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]