search

nus-cs2103-AY2223S2 / pe-dev-response

1 stars 0 forks source link

UG: Inconsistent uppercasing of PARAMETERS #3785

Open nus-pe-bot opened 1 year ago

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

This is the specified convention:

image.png

Uppercase for PARAMETERS is used here.

image.png

A case of PARAMETERS not in uppercase

image.png

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

engenhui1999 commented 1 year ago

Team's Response

The format under the "Example" is used to show how the "parameters" will be inside a code block similar to the "commandword". The "commandword PARAMETERS" is simply used to emphasise to the readers that the parameters is meant to be replaced with whatever the user wishes to input. This is not a bug, but rather the style chosen for writing the User Guide.

Duplicate status (if any):

--