search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Inconsistent notation: words in angle brackets are parameters #882

Open nus-se-script opened 7 months ago

nus-se-script commented 7 months 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 it's stated

Words in angle brackets <> are the parameters to be supplied by the user.

But this notation is not followed throughout the document. This can cause confusion for the user, worst case typing in the capital letters literally.

[original: nus-cs2103-AY2324S2/pe-interim#720] [original labels: severity.Medium type.DocumentationBug]

ys112 commented 7 months ago

Team's Response

Thanks for bringing up the issue.

Duplicate status (if any):

--