search

Richardtok / pe

0 stars 0 forks source link

UG expected output missing #31

Open Richardtok opened 1 year ago

Richardtok commented 1 year ago

image.png As can be seen in the picture there is no expected output and this could be a huge problem for the user as they do not know what to expect w=once they input a command

soc-pe-bot commented 1 year ago

Team's Response

Our intention was to standardize the same format for all functions to prevent the UG from becoming too lengthy given the large number of functions. However, we understand that it might be better to include in at least a small example to give the user a better idea on what is to be expected. We have changed the severity to low since it does not affect the usage of the program itself, and the user can test the functions with the default database to see the expected output.

The 'Original' Bug

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

Lack of screenshots for the expected outputs of the commands in the UG

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.

Expected

Examples of commands to be entered into the app and screenshots of the expected output from that command.

Actual

There are example commands but no screenshots of the expected output from that command.

Screenshot

image.png

[original: nus-cs2113-AY2223S2/pe-interim#1643] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

Our intention was to standardize the same format for all functions to prevent the UG from becoming too lengthy given the large number of functions. However, we understand that it might be better to include in at least a small example to give the user a better idea on what is to be expected.

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: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** This bug could be a medium bug as some commands such as the add command will not output anything if the user inputs correctly when there should be a prompt reassuring the user that it is a correct input.