Punpun1643 / pe

0 stars 0 forks source link

Inconsistency of tag format in the UG #12

Open Punpun1643 opened 2 years ago

Punpun1643 commented 2 years ago

A4942093-F980-4812-A2D0-7BE46E4B8EEB_4_5005_c.jpeg

Should have been n/NAME [t/TAG]... although you are trying to explain that tag is optional, this does not change the fact that there can be any number of tags. Should provide consistency to all command format [t/TAG]... should have been used just like the below screenshot.

C6F927C3-08CD-4F67-817F-43B9CE84EA27_4_5005_c.jpeg

nus-se-script commented 2 years ago

Team's Response

The first tag format (in the blue info box) is only for illustration purposes, and to serve as an example of a use of square brackets; it neither mentions the personadd command, nor implies that the snippet is used (or should be used) verbatim in any part of the application.

Furthermore, your suggestion (to replace n/NAME [t/TAG] with n/NAME [t/TAG]...) might've introduced another potential avenue for confusion for readers, since it attaches irrelevant features (i.e. the ellipsis) to the format feature being described.

In light of this, we are rejecting this issue.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]