LINCHENYU2030S / pe

0 stars 0 forks source link

Documentation of deleteContactEvent is not well formated. #6

Open LINCHENYU2030S opened 10 months ago

LINCHENYU2030S commented 10 months ago

The different example command is given right before the screenshot and there's no space / other way to separate this which will make user confused, though the actual command that matches the result in the screenshot is given after the screenshot.

suggestion: give space or use other way to separate the example command that does not match with the screenshot.

Screenshot 2023-11-17 at 5.29.45 PM.png

nus-pe-bot commented 10 months ago

Team's Response

This issue does not hinder the user in using the command as the input given by the user will have to match an event that in currently present in the contact's calendar instead of either of the examples for the command to succeed. However, it is possible to have the above example match the one below the image so as to improve clarity.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Screenshot 2023-11-21 at 6.41.08 PM.png I still think that for a user to read through a user guide, it is better to provide input before output instead of output before input. So I judge this as an improvement under neatness -> not well-formatted. Furthermore, there is no any spacing to separate the first example command and the output picture which may confuse the user until the user discovers the text below the output picture. But given that this is just a minor issue, I consider it as a very low severity documentation bug.