search

Xilef121 / pe

0 stars 0 forks source link

Insufficient images to better illustrate delete command after list command. #10

Open Xilef121 opened 5 months ago

Xilef121 commented 5 months ago

Screenshot 2024-04-19 at 5.14.35 PM.png

The examples mentioned could be better illustrated with visuals to allow users to better understand how the use of delete right after list will work.

nus-pe-script commented 4 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Not enough visuals in User guide

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

Currently there are only visuals for the "find" command and no visuals for the other commands. I feel that there should be more visuals especially for more crucial commands that is more likely to be used such as add command should be added to the user guide so that users can see what is the expected outcome or how to run the command.

[original: nus-cs2103-AY2324S2/pe-interim#1355] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

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

No details provided by team.

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: It is the same type of issue but in a different part of the UG.

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** The later part where delete is used after using a find command is definitely not easy to be understood without any images.