search

nus-cs2103-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Different use of breed and tag between UG and DG #3327

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years 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.

In the UG, t/ is used to indicate a dog breed. It is referred to as the 'breed' field and never a tag field. In the DG, it is only referred to as a 'Tag' and no mention is made that this refers to the breed of the dog. It seems to be a relic of AB3, but it should probably be made more consistent. If Tag is meant to represent the breed of a dog, it makes sense to at least mention that in the DG if not change the name of the class itself.

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

soloplxya commented 2 years ago

Team's Response

For the user guide, it is meant for the user as such we use 'breed' as it is more reader-focused for the target audience. However, in the DG, since the developer is exposed to the inner workings of the application, it makes sense to use Tag in the DG.

Duplicate status (if any):

--