wj331 / pe

0 stars 0 forks source link

Not enough examples for edit command in user guide #18

Open wj331 opened 1 year ago

wj331 commented 1 year ago

image.png

As seen, only 1 example that edits 2 fields phone and email is given, when in fact edit command:

edit INDEX [r/ROOM] [d/BOOKING_PERIOD] [n/NAME] [p/PHONE] [e/EMAIL] [rk/REMARK]

works for up to 6 different fields.

I had to manually type in the d/BOOKING_PERIOD which is: "2023-01-01 08:00 to 2023-01-02 11:00" long with strict formatting requirements

Caused great inconvenience and testing issues as a user and tester

soc-se-bot commented 1 year ago

Team's Response

User: As shown in the screenshot you shown, it is explicitly stated that edit command works for 6 different fields, so we are not sure why having only 2 examples would make the user think that the edit command only works for 2 fields. After all, examples are only sample inputs for the user to see how an input would look like.

Tester: Screenshot 2023-11-18 at 10.44.42 PM.png Screenshot 2023-11-18 at 10.43.16 PM.png As a tester, you would be expected to see the DG, and there is an entire section in the DG about manual testing where you can simply copy and paste values, not sure why you insist on solely using the UG as a reference for testing.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Well, if you have to ask me to refer to the DG when I am at the UG, it is obviously a UG bug that I am picking up on. So this means the team partially admits that the UG inputs are incomplete and is asking me to refer to a more complete version in the APPENDIX of the DG

Furthermore, it is seen in the course website that having Not Enough examples is one form of UG bug as seen in the screenshot below:

image.png


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** As a user, I had to manually type in the d/BOOKING_PERIOD which is: "2023-01-01 08:00 to 2023-01-02 11:00" long with strict formatting requirements. This is actually causing HUGE inconvenience to me as a user each time I have to edit the booking period with no sample in the UG. Furthermore, there is no example input for me to copy from the output window as seen below ![image.png](https://raw.githubusercontent.com/wj331/pe/main/files/fba8c36e-5900-47ae-9758-b25076e73a91.png) This further reduces testability and brings about great convenience to users everytime they need to edit a product even though they can continue to use the product. Hence, I have chosen severity.Medium as it is a huge decrease is testability & usage and brings about great inconvenience.