search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Documentation Flaw : deleteTag images is not helpful #1510

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.

The following part is not helpful

image.png

Firstly, there is no before and after comparism, As a result, the user does not know what the state before the deletion looks like.

Hence just show a "successful delete" with only the DisplayMessage changes in the images is unnecessary and rather duplicative as tag command is very similar. It left the user wonder "what if the tag isn't there in the first place?"

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

Jellybeano commented 3 years ago

Team's Response

We felt that the message was clear enough and users do know what they are deleting.

Duplicate status (if any):

--