Ella-e / pe

0 stars 0 forks source link

Evidences of AddressBook appear in DG's texts #13

Open Ella-e opened 3 months ago

Ella-e commented 3 months ago

There are a lot of instances of the word "addressbook" appear in the DG's text contents. Since this application is about student management (called TeachStack), it is unlikely for them to use the word AddressBook in the DG.

Here are some of the screenshots, there are others that are not shown: image.png

image.png

image.png

soc-pe-bot commented 3 months ago

Team's Response

Thanks for the suggestion. However, we aim to make the DG consistent with the actual implementation of our code. (Our class is still named addressbook).

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: After a thorough look at the team's code, I agree that the use of most of the Addressbook in the DG is correct because it reflects the actual implementation of their code. However, my second part of the argument, "Since this application is about student management (called TeachStack), it is unlikely for them to use the word AddressBook in the DG", still holds. Some of the address book term is used inappropriately. For example, in the model component, it is said in the DG that model "stores the address book data". As a developer reading this line, I am confused about what is the address book data given that the whole system is about managing student and their grades. image.png

From the course's point of view, the actual implementation of the code is not good enough also. Since this application is not about address book, the term address book should not be widely used in the code implementation. This is a violation of the basic naming rule for class because class names should be very clear about what they are representing. In general, there lacks the evidence of effort for the team to change everything from AB3 to that of their product. Moreover, since everything in the UG and the later part of the DG is all about teachStack, usage of Addressbook in this early part of DG raises confusions and is not correct.