search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

DG Storage section missing information on how Student/Tutor and Sessions interact #487

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.

What is the issue

Storage component missing how Students/Tutors/Sessions fit into the Storage (pg 9)

image.png

What it should be

Include how Students/Tutors/Sessions fit into the Storage

Why it matters

The developer reading this should not be left wondering how Students/Tutors/Sessions play into the system's storage component

Severity justification

Medium because it will cause occasional inconvenience to developers trying to understand the project, not VeryLow as its not purely a cosmetic issue, not Low as session is a key part of the system that is not documented under the model section

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

car155 commented 3 years ago

Team's Response

This was left out for simplification as the data is converted to JSON and it is the JSON that interacts with the above subsystem.

Duplicate status (if any):

--