search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Missing implementation deatials for event related features in the DG #2081

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

ISSUE The Developer Guide lacks comprehensive explanations on how event-related features (such as adding, editing, and deleting events) are implemented within the Logic, Model, and Storage components. there are missing sequence diagrams, class diagrams, and explanations for event handling.

The only relevant mention was the delete event sequence diagram image.png

A developer might struggle to understand the inner logic of event management, and in this case, when i tested the event management, there seemed to be quite a significant amount of bugs, and i want to look at the DG to find out what the possible areas that is causing the logic failure in the edit event command, however, i am not able to do so as it is not provided in the DG, the event-related commands made up of half the app and is a key feature, hence it should not be omitted!

[original: nus-cs2103-AY2425S1/pe-interim#887] [original labels: type.DocumentationBug severity.High]

kaoxi998533 commented 1 week ago

Team's Response

Thanks for the catch. It is true that there lacks specific explanation for implementation details in the DG and it can cause serious inconveniences to developers. Thus we agree that the severity should be classified as high.

Duplicate status (if any):

--