search

jeffsieu / pe

0 stars 0 forks source link

Error in the documentation of add in the app. #10

Open jeffsieu opened 2 years ago

jeffsieu commented 2 years ago

Issue

Steps to reproduce

  1. Launch the application and set a password.
  2. Run add, as the user has forgottten the command usage
  3. An error is correctly thrown, and shows the command usage.
  4. The example given is:
add -n "John Doe" -p "98765432" -e "johnd@example.com" -a "311, Clementi Ave 2, #02-25" -t "friends,owesMoney"
  1. Copying the exact command from the usage does not yield a successful result.

Expected behaviour

The example command runs successfully.

Actual behaviour

The example command does not run, and gives the following error. image.png

Screenshots

image.png

Bug severity justification

It is common to forget the format of commands, especially for a new user. The user can't even get started with adding input, given that the example command does not run.

nus-pe-bot commented 2 years ago

Team's Response

Our team argues that severity is medium because the example in the user guide does not include the double quote, hence it makes sense that your input to name is the string "John Doe". As such, it violates the specified constraints. However, we recgonise that this is a typo from our side.

Items for the Tester to Verify

:question: Issue type

Team chose [type.FunctionalityBug] Originally [type.FeatureFlaw]

Reason for disagreement: [replace this with your explanation]

:question: Issue severity

Team chose [severity.Medium] Originally [severity.High]

Reason for disagreement: [replace this with your explanation]