Skip to content

User Guide examples not well-executed #1477

Open
@nus-se-script

Description

@nus-se-script

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]

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions