search

thatseant / pe

0 stars 0 forks source link

Documentation Structure for Deadline Feature is unclear #9

Open thatseant opened 4 years ago

thatseant commented 4 years ago

Examples of usage are provided without a subsection stating so.

Expected output shown without stating it is for the last example.

Screenshot 2020-11-13 at 5.44.40 PM.png

nus-pe-bot commented 4 years ago

Team's Response

Hi, thank you for reporting the bug. However, we do feel that the UG is clear in showing the deadline command as there is a good variation of examples, expected output and step-by-step guide. The above image given by you is to show users a rough guide of how to use in the case they do not wish to read the step-by-step guide. On the next page of the UG, there is a step-by-step guide (shown below) to create deadline for an event. Hence, we reject this bug as we feel that we are able to cater to the different users who wish to use the UG differently and the clarity of the documentation is not affected.

Photo below shows the step-by-step guide from UG:

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Examples of usage are provided without a subsection stating so.

Expected output shown without stating it is for the last example.