casperngeen / pe

0 stars 0 forks source link

DG Model component insufficient explanation #8

Open casperngeen opened 1 week ago

casperngeen commented 1 week ago
  1. The explanation portion did not cover the Project and Assignment classes which were present in the diagram. [see image below for reference]
  2. I'm not too sure if the filtered association between ModelManager and Assignment is necessary, since there is no way of filtering Assignments in the application.

image.png

soc-se-bot commented 3 days ago

Team's Response

Thanks for raising this issue. We notice that you have raised two separate issues in this report.

For the first issue you have raised, we think that the severity of this documentation bug should be "Low" because it is "unlikely to affect normal operations of the product" and "causes a minor inconvenience only". This is because we have shown the associations of the Project and Assignment classes in the Model diagram, as you have pointed out. Furthermore, the behaviors of these classes are also quite similar to the behavior of the Employee class, so we thought that including it in the Developer Guide would make it too cluttered, providing little value in return.

Nevertheless, we admit that we could have written a few sentences to briefly describe the differences between the Project and Assignment classes with the Employee class.

For the second issue you have raised, the filtered association for the Assignment class is used for the listprojectmembers command.

Thanks for pointing this out!

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]