search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Add Command example in the UG results in invalid command error #938

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

image.png

image.png

Issue: when copying and pasting the command specified in the User Guide

command: add n\John Doe i\S1234567A yg\2 p\91234567e\johndoe@yahoo.com a\10 Orchard Road s\Science s\Math

it shows an invalid command format error, without specifying where I went wrong. For new users testing out the app, they may be unable to proceed with the basic functionality of adding students.

The issue seems to stem from the lack of a space between parameters, which is not actually specified in the error message and can cause confusion to the user especially if they are unable to spot the error.

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

JoanneHing commented 1 week ago

Team's Response

Screenshot 2024-11-18 at 10.31.27 PM.png

Thank you for your feedback. First of all the issue of the command missing a space between is due to copying the command from the pdf version of the UG, our team did mention this under the Feature session for the user to take note (as provided by the screenshot above). And the error message is showing the user that the format is incorrect that hint the user what went wrong.

Once again thank you for the feedback but unfortunately our team do not agree with the bug stated.

Duplicate status (if any):

--