search

nickeltea / pe

0 stars 0 forks source link

Edit person command example given in the user guide does not work as described #10

Open nickeltea opened 1 year ago

nickeltea commented 1 year ago

image.png

As can be seen in the screenshot above, the command "edit person 2 -n Betsy Crower -t" is given as an example but the cammand cannot be exceuted despite a valid person index being provided.

The user guide is innacurate.

Severity is low as the other example provided does work, thus users can still figure out how to use the command correctly.

soc-pe-bot commented 1 year ago

Team's Response

Refer #3740 for detailed rationale

The 'Original' Bug

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

edit person command not working

Screenshot 2022-11-11 at 16.24.56.png

Screenshot 2022-11-11 at 16.25.40.png

Screenshot 2022-11-11 at 16.27.01.png

Tried the aliases in the user guide on the example in user guide, but none of them seem to work.

[original: nus-cs2103-AY2223S1/pe-interim#3540] [original labels: type.FunctionalityBug severity.High]

Their Response to the 'Original' Bug

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

Hi, thanks for the bug report!

This is in fact, caused because of not putting quotes around the names rather than the commands not working. We accept that the commands given in the UG are missing quotes and so, this is a valid bug.

Changed the label to documentation bug to reflect the same. Try edit person 1 -n "XYZ" to verify that the functionality works :) You should see the following output:

Screenshot 2022-11-12 at 5.04.13 PM.png

Changed the label to low for the following reasons:

  1. Although this causes some inconvenience to the user, the help message shown to the user in the application is correct. We also prompt the user (as seen in your screenshots) to run the edit person --help command. The user can simply type edit person --help to view the help message which explicitly includes quotes. Here's an example: Screenshot 2022-11-12 at 5.05.36 PM.png

In other words, this is just an inconsistency between the UG and the actual help command. Since users can always access the help message in the application, we don't think this is a big issue.

  1. The UG also mentions to put quotes for arguments that have multiple words (although admittedly, we forgot to do the same for our examples) in an separate section devoted to explaining the CLI of the application.

image.png

  1. Lastly, if the user does not realise that he/she needs to put quotes in the edit command, he/she can always delete the person and add them back again with the edited details (which causes minor inconvenience).

We hope you understand our rationale

Have a nice reading week ahead!

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]