search

nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

bug(DG): DG Does not specify each UI Class #5685

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year 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.

image.png

NO explanation on WHAT and HOW each class of the UI works

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

zacchaeuschok commented 1 year ago

Team's Response

The omission of lower level details of each UI Class was an intended feature of our developer guide. The main intention of the section on UI component was to explain the role of the UI component in relation to the application’s overall architecture. In fact, the UI component was designed as a facade to hide away lower-level details on how each individual UI Class operated, and developer’s need not worry about the implementation of the individual classes but instead interact with the overall UI component instead.

Duplicate status (if any):

--