search

nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

UG examples do not work when inputted #5753

Open nus-se-bot opened 3 years ago

nus-se-bot commented 3 years 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.

Most of the examples don't work as given in the UG because usually some steps are needed before (such as adding a group to a student, but the student doesn't exist yet.)

Example:

From UG

Screen Shot 2021-11-12 at 5.12.43 PM.png

Actual

Screen Shot 2021-11-12 at 5.12.10 PM.png

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

jonas-chow commented 3 years ago

Team's Response

The examples in the UG are just meant to provide the reader with a rough understanding of the format of the command, and are not meant to be followed word-for-word. We believe our readers, who are Professors of CS1101S, are smart enough to discern this.

Duplicate status (if any):

--