yapxuanxuan / pe

0 stars 0 forks source link

Inconsistency in Error Message for 'help edit' #1

Open yapxuanxuan opened 6 months ago

yapxuanxuan commented 6 months ago

Steps to Reproduce:

  1. type in command 'help edit' and press enter
  2. type in command 'edit 1 h/@john_doe s/A1234567X e/johndoe@example.com '

Expected:

Actual:

As seen in the picture, Example 1 gave an example command: edit 1 h/@john_doe s/A1234567X e/johndoe@example.com, however this command did not work. This command is in a different format from the example 2 command (which worked). Possibly forgot to change/update

image.png

image.png

nus-pe-script commented 6 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]

The example 1 of the Edit Command Help page does not work

How to reproduce: Copy the following from example 1 of the edit command : edit 1 h/@john_doe s/A1234567X e/johndoe@example.com

image.png

Expected outcome: Edits the student id and email address of the 1st student to be A1234567X and johndoe@example.com respectively.

Actual outcome: The command format is invalid: image.png image.png

Reason for having medium severity: A new user to EduConnect would try all the example commands, in this case will just copy and paste. Once he try to execute the command he will be confused as it said it's a Invalid command format!


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

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