AaronCQL / pe

0 stars 0 forks source link

DG sequence diagrams for Reminder feature missing/wrong details #17

Open AaronCQL opened 4 years ago

AaronCQL commented 4 years ago

Figure 26: what does LogicManager call ReminderCommand for? And what did ReminderCommand eventually return to LogicManager? Screenshot_20200417_153355.png

Figure 27: does ReminderCommand actually instantiate JelphaBot? Or is it calling some other method from an already instantiated JelphaBot? Screenshot_20200417_153613.png

nus-pe-bot commented 4 years ago

Team's Response

LogicManager calls ReminderCommand to carry out the addReminder to save the reminder into the application.

The second box should be CommandResult instead of JelphaBot. However, does not affect application running.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Medium] Originally [severity.High]

Reason for disagreement: I am not quite sure what the developer meant by "does not affect the application running" since this issue is about the developer guide, not the application. Moreover, the original sequence diagram made a reference to the addReminder sequence diagram:

Screenshot_20200421_140955.png

However, no such reference frame/diagram was shown in the DG.

As such, I believe all the mistakes shown here (especially figure 27) will portray a very inaccurate picture of how this feature actually functions, and hinders the user's ability to understand what is going on. Since no proper argument was given as to why the severity was downgraded, I believe it should retain the severity.High label.