search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Adding Sample Data Section - Copy and Pasted Commands do not work off the bat #4511

Open nus-se-script opened 6 months ago

nus-se-script commented 6 months ago

I was following the UG and tried to type in step 3 based on the given sample command given

image.png

However I received this error in dook, which doesnt allow me to add in the sample contact off the bat

image.png

image.png

it is only after I realised that it is missing a space between -e and bsmith@example.com that the functionality works fine, for which new users may not necessarily see at first glance, especially if they are new to CLI

Same case for adding a consultation - copy and pasting the command gives me an error image.png

Functionality is ok, I realised that you missed out the -note field in giving the sample command image.png

I am choosing to give this bug a medium rather than a low or very low as I had quite some trouble understanding and getting past even the sample data portion, starting off strong in your user guide is necessary for first time users, and running into simple errors like this hinders the user guide's usefulness if problematic or unformatted commands are given.

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

cyqjoseph commented 6 months ago

Team's Response

No details provided by team.

Duplicate status (if any):

Duplicate of #513