laurenlhy / pe

0 stars 0 forks source link

Outdated screenshot in UG #3

Open laurenlhy opened 3 years ago

laurenlhy commented 3 years ago

Screenshot in UG for 'find' command:

image.png

However, this command is not valid in the app.

image.png

nus-pe-bot commented 3 years ago

Team's Response

No response provided.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Image in UG is not using the same command as described

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


image.png

"find e/example" is used instead of find "e/gmail"


[original: nus-cs2103-AY2021S2/pe-interim#357] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Both examples serve their purposes.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: The original bug brings up the issue that the screenshot does not match the words. The examples given in the text and in the screenshot are all valid examples, since the "e/" prefix is used.

However, my bug report was about how the screenshot in the UG shows an invalid example which cannot be used in the app, since it does not use the "e/" prefix before the email. Thus it may confuse the user in a different way that is not related to the original bug.


:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: My bug report was about how the screenshot in the UG shows an invalid example which cannot be used in the app, since it does not use the "e/" prefix before the email. Thus it may confuse the reader since the given input appears to work in the UG, but will not work in the app. This is a valid documentation bug.


:question: Issue severity

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

Reason for disagreement: The documentation bug is just a matter of updating the screenshot(s) in documentation and it is of very low severity.