nus-cs2113-AY2223S2 / pe-dev-response

0 stars 0 forks source link

Inaccuracy in the User Guide #844

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.


Technically speaking, the modules are recurring WEEKLY. However, the user guide and the product explicitly shows that the module is not recurring which is inaccurate.

Screenshot 2023-04-14 at 5.22.25 PM.png


[original: nus-cs2113-AY2223S2/pe-interim#1135] [original labels: severity.Low type.DocumentationBug]

hrithie commented 1 year ago

Team's Response

The reason why we recognise each tutorial/lecture/laboratory as an individual event and not as a recurring event is explained in the User Guide and the Developer Guide.

As stated in User Guide section 2.4.2:

It is necessary to have a list which contains all the current event/class so that we can show/batch process events more efficiently. Moreover, this component serves intermediary functions and avoids other classes access deep into the functionality of the classes (Events, Schedule, etc) inside the ArrayList, thus reduces the coupling code base.

Developer Guide explanation:

Modification of specific module slots (tutorial, lecture, etc) are allowed in the event of public holiday/NUS Wellbeing day. This ensures that users have full control over their timetable and can make easy edits if their professor or teaching assistant decides to change the day/time slot.

The purpose of adding each module as an independent event is to allow flexibility to the user as module venues and timings do change at times due to unforeseen circumstances. By adding each module's lesson as a single event, the user is then able to edit accordingly should they need to.

Duplicate status (if any):

--