search

tim-pipi / pe

0 stars 0 forks source link

Outdated Names #3

Open tim-pipi opened 12 months ago

tim-pipi commented 12 months ago

The log of the app still refers to the old Address Book app. This may be confusing to the users.

image.png

Address book reference should be changed to customer list?

image.png

nus-pe-bot commented 12 months ago

Team's Response

Users are not meant to use the terminal. Only the GUI should be of concern.

No, PropertyMatch address book is correct, that is how we named the file.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Hi there,

I appreciate your prompt response regarding the references to "AddressBook" in the application. However, I would like to further clarify my concerns and the importance of addressing them.

Consistency and Clarity in Codebase: While it's understood that users primarily interact with the GUI and not the terminal, the references within the code and logs are crucial for maintainability and clarity. Using outdated or inaccurate terms like "AddressBook" in a property matching application can lead to confusion among developers, especially new team members or contributors who might work on the code in the future. It's essential for the internal naming and documentation to accurately reflect the current functionality of the application.

Accuracy in Naming Conventions: The term "AddressBook" suggests a functionality that is not aligned with the current purpose of the application, which is now focused on property matching. The use of this term becomes more misleading when considering that the customer list does not include addresses. This inconsistency might not impact the end-user experience directly, but it affects the internal logic and understanding of the application. In addition, I believe that the Use Case's "System" could simply be "PropertyMatch" instead as adding "address book" seems to be bringing more confusion than benefits (if any).

I hope the team will reconsider the importance of updating these references, not just from a user-facing standpoint but for the overall health and integrity of the application's codebase.