nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Description of Tagging Persons #3033

Open nus-pe-bot opened 3 years ago

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


Here the format of tag shown in the UG will confuses user that it is a command or not.

image.png


[original: nus-cs2103-AY2021S2/pe-interim#3033] [original labels: severity.VeryLow type.DocumentationBug]

tanboonji commented 3 years ago

Team's Response

First of all, your description of the issue is not clear enough for us to know what exactly is the format of tag you are confused with.

However, we would still reject this issue because:

1) It is stated that the The tag command allows you to add and delete specific tags of persons. which states that tag is a command.

2) Following the tag command section in the UG (right after your screenshot), are the tag add and tag delete sections. These two sections are subsections of the tag command and clearly explains how you add and delete tags with the tag add and tag delete subcommands.

We do not think that the format for the tag command is unclear, and the screenshot you provided can be misleading. The following is a screenshot of the tag command followed by its subsection tag add. With the different header size and the tag add subsection right after it, we disagree that it confuses the user.

image.png

Duplicate status (if any):

--