not enough code in DG

[nus-pe-bot]

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 are many diagrams in the DG, but no code (function examples, class example, code snippets) that help the reader better understand

---

_{[original: nus-cs2113-AY2324S2/pe-interim#1903] [original labels: severity.Medium type.DocumentationBug]}

[dtaywd]

Team's Response

According to the format in AB-3, the developer guide should have an emphasis on using UML diagrams to explain the high level logic of the program. We believe that our UML diagrams are sufficiently detailed to explain the logic. However, we do not believe that copying and pasting huge code blocks would be beneficial for helping developers understand our code better. If developers wish to look at our code, they have our GitHub for that purpose. We believe that the main benefit of the developer guide should not come from looking at code, but by understanding the processes behind the code supported with clear and intuitive explanations.

To counter this issue, we do in fact have some small snippets of code that we use to cite methods and classes as can be seen from the example below:

Duplicate status (if any):

--