search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Some important keywords are not coded #2908

Open nus-pe-bot opened 5 days ago

nus-pe-bot commented 5 days ago

For example, in the screenshot below, it would be better if all of these keywords such as ADDRESS and CUSTOMER_LIST are coded.

image.png

only a few users might be confused so the severity is low.

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

winstonlimjy commented 3 days ago

Team's Response

ADDRESS here refers to a parameter, that is why it is in code block:

image.png

However, address, rental start date, monthly rent, rental end date, rent due date, deposit amount and customer list here refer to normal nouns, otherwise we will phrase it differently and use all uppercase. In addition, if we were to code all the values, it will be unreadable for the user and lose the meaning of the code block.

image.png

Lastly, severity should be veryLow as it is purely cosmetic issue and does not hinder understanding.

Duplicate status (if any):

--