search

wamps-jp / pe

0 stars 0 forks source link

`clear` command not made clear #14

Open wamps-jp opened 10 months ago

wamps-jp commented 10 months ago

Given that the clear command only clears the entries from the displayed list, this allows for two important uses:

  1. It allows the user to use the clear command more flexibly, such as deleting multiple employees at once without clearing the whole database.
  2. It makes the clear command no longer, by default, clear the entire database (which certain users may assume to be the case).

However, in the UG, the explanation for clear is only the following:

image.png

As such, I would recommend adding some visual examples, or some more examples of how clear can be used, as well as emphasizing that clear does not clear the entire database - since in many programs that is how it works.

soc-pe-bot commented 9 months ago

Team's Response

Thank you for your input. In the UG, we mentioned "Clears the current displayed list", we believe this shows that clear will only clear the current list. In addition, we believe that this interaction should be quite straightforward for the user and there is no need for a visual example. Moreover, adding a visual example requires three images, one to show the starting state, one to show the results after clear and one to show the full list by using the command list. This might result in too many examples and hence hinder the reader.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While you are correct in that visuals specifically may be overdoing it, I believe more explanation (or a sample workflow) would help to reinforce the fact that in this program, clear is a much more versatile command than it would initially seem.

For example, adding a section on examples of using clear that contains workflows like:

If you want to delete all employees with ID numbers B0...:

  1. Call find i/ B0
  2. All employees with IDs B0... are displayed.
  3. Call clear

This is a clunky example, but I believe simply having examples would allow the user to understand that clear can help them a lot in daily operations, as opposed to many other CLI apps, where clear is often a command only used as a last resort.