search

ysl-28 / pe

0 stars 0 forks source link

Methods missing from class diagram for recurring deadlines #15

Open ysl-28 opened 1 year ago

ysl-28 commented 1 year ago

Some methods are missing from the class diagram.

In Task, both getPriority() and setPriority() are listed as methods of the Task class.

However, RecurringDeadline only has its getDay() method listed and its setDay() method is missing.

The same applies for RecurringEvent who is also missing its setDay() method.

classdiagram_missingmethod.PNG

rec_deadline.PNG Methods of RecurringDeadline

rec_event.PNG

Methods of RecurringEvent

nus-pe-script commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Methods missing from Event class

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.

The Event class in the class diagram is also missing its setter methods (setStart and setEnd), despite theTask` class having them.

classdiagram_missingmethod.PNG

event_setstartend.PNG

Methods in the event class

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thanks for the catch! We believe that this should be low severity instead.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: See issue severity explanation - the bug can technically be fixed independently of the bug that it was marked as a duplicate of.

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I feel that having incomplete UML diagrams that leave out methods fit the definition of a Medium severity bug more closely than that of a Low severity bug. This is because having methods be missing from UML diagrams can confuse potential developers reading the DG regarding the basic details of how one's program is implemented, which goes beyond just a "minor inconvenience that appears only in very rare situations" (the definition of a Low severity bug). Furthermore, this bug can be fixed independently of the other bug that it was marked as a duplicate of (Event class missing methods). Since the same bug appears in more than one place but is independently fixable, it is worth considering to increase the bug severity to Medium.