search

tanjiaxian99 / pe

0 stars 0 forks source link

Architecture-level diagram of Model.java does not match java file #22

Open tanjiaxian99 opened 2 years ago

tanjiaxian99 commented 2 years ago

The DG suggests that Person contains Task, Importance, Description, ...

image.png

However, in the Person.java file, there are no references at all to Task, Importance and Description.

image.png

nus-pe-bot commented 2 years ago

Team's Response

image.png

I am not sure where you got that block of code, but from the code in our team repository, the Person class clearly has Task, Importance and Description references.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I realised that my screenshot came from clicking the Main.java link on page 9 of the DG, which led me to the AB3 codebase. The discrepancy in code observed is thus the result of a broken link.

I would argue that this is still of medium severity because as a developer, I will definitely click on the various links in the DG to bring me to the specific parts of the codebase. Seeing a codebase that contradicts the Architecture-level diagram would be so confusing. To later find out that the codebase is for a similar but different product would make it troublesome even for experienced users as they have to now open up the team's Github page and navigate to the correct section all by themselves every time they use the DG. Further, even if I have the team's codebase on my local machine, I will also be confused by the difference in code.