search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

UG command formatting may cause confusion #785

Open nus-pe-bot opened 2 weeks ago

nus-pe-bot commented 2 weeks ago

Issue

Tips and notes on the argument should be left after the command format is shown, as users are not even sure of what is the correct format of the command and the arguments required for the command, however tips and notes of the arguments are being shown first.

image.png

Suggestion

Move the notes to be in between the command format and example commands instead.

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

davidgohzk commented 1 week ago

Team's Response

Thank you for your bug report.

As quoted from the issue: Tips and notes on the argument should be left after the command format is shown.

This is an opinion rather than a fact.

Placing important notes about the fields (like constraints and expected formats) before the command syntax ensures users are aware of the rules and constraints before they start working with the command. This minimizes confusion, especially for users unfamiliar with specific restrictions.

In addition, this is consistent with the other commands where the information is shown first before the command syntax.

image.png

Have a great and wonderful day!

Duplicate status (if any):

--