search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Lack of code screenshots #1903

Open nus-pe-bot opened 3 years ago

nus-pe-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.

there were no snippets of code provided. i understand why this was so and agree with the decision but perhaps one or 2 screen shots of the code would have really elevated the DG (especially the command history option as personally it was my favourite)

[original: nus-cs2103-AY2021S2/pe-interim#1903] [original labels: severity.VeryLow type.DocumentationBug]

glennljs commented 3 years ago

Team's Response

We do not believe there is a relevancy of including code snippets in the DG, whose purpose is to assist people in understanding our code base from a glance. In fact, with little context, code snippets may reduce the DG readability and increase clutter.

Duplicate status (if any):

--