search

lshaoqin / pe

0 stars 0 forks source link

Inconsistent naming - StudentGrade is sometimes referred to as StudentScore #23

Open lshaoqin opened 12 months ago

lshaoqin commented 12 months ago

image.png

There is potential for confusion here.

soc-pe-bot commented 11 months ago

Team's Response

Thanks for your feedback! It is true that there is typo here and what we meant is Ssc(Student, StudentScore and GradedComponent) instead. However, given that there are correct labelled diagrams below, I believe this will not hinder readers' understanding much. Hence, I consider it as a typo issue with severity Low.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: 1. In the attached screenshot, the diagrams are misleading especially because of the composition relation between Student and StudentGrade, and between StudentScore and Student. This strongly suggests that StudentGrade and StudentScore are two different objects (since objects cannot compose each other) which confused me during the testing.

  1. I thought that StudentGrade was actually the correct name of the class because there are other places in the UG where this is used, such as in the "Proposed features" section.

image.png

I believe there is a high risk of misunderstanding because of these issues.