github-amanda / pe

0 stars 0 forks source link

Unclear explanation in user guide #16

Open github-amanda opened 3 years ago

github-amanda commented 3 years ago

The "delete_session" aims to delete a recurring session for student "Alex Yeoh". However, this is a recurring session. The term "first and only" session doesn't really seem relevant here. As a user, I had to read multiple times and compare this to the "delete_rec_session" function to tell what exactly this function does. Maybe you can be clearer in explaining what does "first and only" means, or rephrase the explanation to make it clearer to users :)

image.png image.png

nus-pe-bot commented 3 years ago

Team's Response

Hi, sorry if you are not able to understand the command well. However, we felt that if you have looked at the image before point 3 clearly (Somehow the image wasn't inside your screenshot), you should have known that the "first and only" means that based on the screenshot, Alex Yeoh only has 1 and only 1 session that will be deleted after running this command.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Just to clarify what I meant, I believe recurring sessions meant that there are multiple sessions. As seen from your screenshot as well, student Alex Yeoh will have multiple sessions from 10 March 2021 to 07 April 2021, with a 7-days interval between each session. However, from your explanation, it implies that student Alex Yeoh only has 1 and only 1 session, which confuses me as a user.


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]