search

nus-cs2103-AY2021S2 / forum

10 stars 0 forks source link

Are unexplainedcomponents bugs? #322

Closed nowknowing closed 3 years ago

nowknowing commented 3 years ago

In DG, we did not explain certain components. Are missing component explanations bugs? For instance, not explaining Common, which came from AB3.

damithc commented 3 years ago

OK to omit details if not important or if the omission doesn't hinder/misleads the reader. Note how AB3 mentions the Common classes but doesn't go into details. 'came from AB3' is not a valid reason to omit though, as the reader doesn't know anything about AB3.

nowknowing commented 3 years ago

I see thank you!