search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

User Guide examples not well-executed #1477

Open nus-se-script opened 6 months ago

nus-se-script commented 6 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

Steps to reproduce: Login to the app enter "edit-reminder i/2 n/water_bills a/35 d/21/06/2024 t/1200 c/UTILITIES", from the user guide

Screenshot 2024-04-19 at 5.23.30 PM.png

Due to the nature of CLI, with the '_' used in the example in the user guide, newline will be introduced, leading to errors such as the ones below. Do consider having better examples that the user can copy and paste to try out the app.

Screenshot 2024-04-19 at 5.21.50 PM.png

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

Kishen271828 commented 6 months ago

Team's Response

I've tried doing exactly as you said but it works fine for me. You can check the below video for proof


video:https://raw.githubusercontent.com/nus-cs2113-AY2324S2/pe-dev-response/main/files/514dcdfd-c668-4622-be40-f3975f3d1770.mp4

Duplicate status (if any):

--