nus-tic4002-AY2021S2 / pe-dev-response

0 stars 0 forks source link

[t/TAG] did not following with ... in UG add command documentation #147

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.


As described in Notes about the command format, the items that can have 0 to many instances should be followed by ... as shown below:

image.png

But only app/ has been followed with ...

image.png

This may result in minor confusion for the reader, but the reader can understand this is a typo. Thus, I rate it as severity low.


[original: nus-tic4002-AY2021S2/pe-interim#147] [original labels: severity.Low type.DocumentationBug]

skyventus commented 3 years ago

Team's Response

Down the severity to verylow because of missing ... is a typo. as we uses square bracket to represent a list of tags too.

Duplicate status (if any):

--