nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Unintuitive Nomenclature: MONEY_OWED #1716

Open nus-se-script opened 4 months ago

nus-se-script commented 4 months 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.


Description

Screenshot 2024-04-19 at 17.17.47.png

When MONEY_OWED is used, it suggests that you are the one owing the money, also the fact that you are using negative owing to suggest someone owing you, there is an introduction of double negatives which can be confusing to users.

Fix

You could consider changing it to AMOUNT, which is neutral and does not interfere with the interpretation of the values under the $/ tag.


[original: nus-cs2103-AY2324S2/pe-interim#1415] [original labels: severity.Low type.DocumentationBug]

JerryO3 commented 4 months ago

Team's Response

Would like to clarify where you get the notion: "When MONEY_OWED is used, it suggests that you are the one owing the money,"

"Money owed to me" suggests money we are owed while "Money owed to others" suggests money we owe. Therefore MONEY_OWED is not a loaded term.

However, we do acknowledge that term used can be clearer, like your suggested term "amount", as well as your concern on double negatives. We however believe that this discussion on semantics is both subjective and based on language, which is out of scope.

Duplicate status (if any):

--