search

nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Help Command code snippet in UG unnecessarily long. #2964

Open nus-se-bot opened 2 years ago

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

Help Command code snippet in UG is unnecessarily long (about 3 pages). Maybe the team could have included a short sample screenshot or left the snippet out of the DG altogether.

image.png

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

tlyi commented 2 years ago

Team's Response

As suggested by our CS2101 tutor, we should include the whole expected output for the command. Due to limitations of PDF, we were unable to put this into a dropdown to make it look shorter.

Duplicate status (if any):

--