search

nus-cs2113-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Layout issues for additional syntax on - how argument values with spaces should be enclosed with double quotes #754

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.

Screenshot 2022-11-11 at 5.25.43 PM.png

This section located on Page 6 of the User Guide, explains about how Argument values with spaces should be enclosed with double quotes. However, as a user, I have not even been introduced a single functionality yet, such as Add-Expense, hence it is confusing for me as to what is going on here since I have not been introduced to the structuring of command for Add-Expense.

My recomemndation will be to place this on Page 13, where it explains the first functionality of add-expense, and highlighting the requirement of enclosing with double quotes there instead. Here, the user will be able to better understand what's going on.

[original: nus-cs2113-AY2223S1/pe-interim#787] [original labels: severity.VeryLow type.DocumentationBug]

jeyvia commented 1 year ago

Team's Response

Hi there,

Thank you for the recommendation. However, clarifying the command syntaxes before introducing a user to our commands would make it more user centric, as we have clearly pre-defined how commands should be entered.

Duplicate status (if any):

--