search

AidenLYT / pe

0 stars 0 forks source link

UC03 : Extensions mistake #8

Open AidenLYT opened 5 months ago

AidenLYT commented 5 months ago

image.png

Description

Similar issue to UC01, TA Toolkit should check for the necessary fields at step 1 before moving on to step 2, modifying the values.

Idea

2a, 2b, 2c should be 1b, 1c, 1d where TA Toolkit checks for the field when User enters the command before actual modifying the values in step 2.

Correct Extension is used in UC05

nus-se-script commented 5 months ago

Team's Response

Thank you for the feedback. However, the placement of these steps as Extension 2a, 2b, 2c is intentional. This is because during step 2 in MSS, TA Toolkit attempts to edit the contact details. However, during this process, the checks realise that doing so would cause an error because:

  1. Student does not exist in the list of students
  2. The updates student contact is the same as the original student contact
  3. This would cause 2 contacts to have duplicate fields

Therefore step 2 in MSS fails, causing the extensions 2a, 2b, 2c.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: image.png

Given the feedback posted by Prof Damith, a better approach to writing the MSS could be as follows:

  1. User enters the command to update a student's details
  2. TA Toolkit modifies and displays a success message along with the student's updated contact details

This in terms still fall under Documentation Bug as per the guideline given in the course website:

image.png

Such documentation caused confusion for readers using the DG:

image.png