search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Purpose of tag #1964

Open nus-se-script opened 3 months ago

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

Screenshot 2024-04-19 at 5.26.34 PM.png

Whilst the purpose of the attributes mentioned in the UG, such as height, weight are all made very clear, what exactly is tag supposed to represent?

Would be good to get more details on it, be it in the add command section or maybe in the parameter constraint portion of the UG.

I think this quite a serious concern as the user as tag also appears in other commands and seems to be a key component of the app, hence I have elevated the following documentation bug as medium instead of low.

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

dillontkh commented 3 months ago

Team's Response

image.png

"Tag" is an English word, not a term unique to our application.

Thus, we have decided to reject this suggestion.

Duplicate status (if any):

--