search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

An example in the AB3 does not work #2493

Open nus-se-script opened 5 months ago

nus-se-script commented 5 months ago

Details: The example provided in the UG at the second last page, 7 Command Summary has provided an example with the date that is invalid on the day of testing.

Steps to reproduce:

  1. Run the application.
  2. Go to the UG 7. and copy the add command example add c/FoodPanda p/12345678 e/panda@food.com a/CBD t/I jd/Front End Intern d/15-04-2024 0900 id/6 months s/500 n/-
  3. Press enter

Expected: A successfully executed command

Actual: Invalid date

Screenshots:

image.png

Rationale: The examples should always work in the UG, as they are meant as a guide for the user. While I understand that dates could "expire" (as the users may read it after the deadline), more appropriate steps should be taken to ensure that this does not happen (putting in a comment to enter a date 3 days from now for example) etc. The UG is meant for new users who are not yet familar with the application, and this may confuse them.

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

eunrcn commented 5 months ago

Team's Response

No details provided by team.

Duplicate status (if any):

--