search

nus-cs2113-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Unclear compose instructions #1350

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.

In compose, Not very clear what it is meant by "user should enter accordingly". Is it supposed to be new line breaks? It is shown in the code snippet but the prose is ambiguous. image.png

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

FarmZH98 commented 3 years ago

Team's Response

The example in the user guide was suppose to help the user understand clearer. If we were to explain further, the description might become too lengthy.

Duplicate status (if any):

--