search

nus-cs2103-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Format for macro command is inconsistent #5982

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.

The format for macro command is inconsistent throughout the user guide.

Screen Shot 2020-11-13 at 6.16.16 PM.png

Screen Shot 2020-11-13 at 6.16.03 PM.png

[original: nus-cs2103-AY2021S1/pe-interim#5972]

JoeyChenSmart commented 3 years ago

Team's Response

Thank you for the bug report.

Firstly, we will be changing the severity to Low instead of Medium. This issue is unlikely to affect normal operations of the product and will only occur on execution of this specific example which will thus cause a minor inconvenience only. Refer to image below:

image.png

Next, we agree that this is inconsistent, and the version above provides slightly more details.

However, the version below also provides enough information to the user to be able to use this command if he knows how the command works, but simply forgets the format (this is the purpose of the command reference).

Duplicate status (if any):

--