nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

DG sequence diagram: activation bar #2096

Open nus-se-script opened 3 months ago

nus-se-script commented 3 months 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.


Seen on page 10 of DG. Screenshot 2024-04-19 173557.png Should the newly created MealList, DrinkList and ExerciseList objects return to :User as myMealList, myDrinkList and myExerciseList respectively? Afterwards, shuold their activation bars be deactivated? The activation bars for these 3 objects span the entire sequence diagram, which should not be the case as their methods are not continuously being used throughout handleViewXYZ().


[original: nus-cs2113-AY2324S2/pe-interim#1866] [original labels: severity.Medium type.DocumentationBug]

claribelho commented 3 months ago

Team's Response

The activation bars were not deactivated as the sequence diagram shown was only used to display the interaction for the method where the user would like to view the nutritional content (as mentioned in the DG). Thus, the objects of mealList, drinkList and exerciseList had not been deleted in this case (should only be deleted when exit is called)

Duplicate status (if any):

--