search

Eugenetanwl3881 / pe

0 stars 0 forks source link

Lack of example outputs/outcomes for UG examples #13

Open Eugenetanwl3881 opened 2 years ago

Eugenetanwl3881 commented 2 years ago

Although the UG examples were good at giving multiple examples to try, there was a lack of explanation/pictures of what the final outcome will be like after the command. This can make it unclear for readers, especially if they encounter errors in the command and are not sure what to do/expect

image.png

soc-se-bot commented 2 years ago

Team's Response

Hi,

Thank you for your suggestion. We think the expected outcomes of such commands as add, edit, and delete are trivial. The user can immediately see what changes after they enter the command. In case of failure or error, we also provide enough error messages to tell the user what to do. Therefore, the user does not need user guide to identify by their own whether the outcome is expected or not. For commands whose expected outcomes are hard to verify, such as the match command, we inserted some screenshots to tell the user what they should anticipate.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]