search

nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Developer guide uses unknown terms. #3636

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year ago

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.

Developer guide uses AddressBookParser in the diagrams and explanation.

Checked the source code to find that the team is indeed using AddressBookParser in their code.

However, may confuse the developer as to what "AddressBook" is.

Screenshots:

image.png

image.png

[original: nus-cs2103-AY2223S1/pe-interim#3400] [original labels: severity.VeryLow type.DocumentationBug]

pratham31012002 commented 1 year ago

Team's Response

AddressBook is a common term used in the entire DG to refer to the component of CLInkedIn. CLInkedIn is also an example of an addressbook. Hence, we decided not to refactor the name of the AddressBookParser class and other classes, and this shouldn't be a source of any confusion for the developers. Hence, we feel that this is an invalid bug.

Duplicate status (if any):

--