Timothyoung97 / pe

0 stars 0 forks source link

Instance of AB3 #5

Open Timothyoung97 opened 2 years ago

Timothyoung97 commented 2 years ago

In DG, instance addressbook can be found .

While I checked that in your codebase, there is no renaming of classes that carry the name of addressbook to your product's name. However, this can be rather confusing since developers might be mixed up with the two products.

image.png

nus-pe-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

A lot of instances of AB3

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


After reading through DG, I realised that Many areas remain as AB3. Should not have so many AB3, since it is a different product. Very hard to reference.

image.png

image.png

In addition, I believe that the architecture of the product is now different from AB3 since the team added quite a lot of features such as lessons, edit remark panels.

all these should be included in the architecture diagram


[original: nus-cs2103-AY2122S1/pe-interim#1868] [original labels: severity.High type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Accepted that DG Architecture should include new components added on top of base AB3.

The phrases 'AB3' and 'addressbook' are still used in some areas of code and documentation due to TutAssistor being based on and keeping certain aspects of AB3, including the addressbook functionality. This is stated in the acknowledgements section at the start of the DG.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]