Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update UG #242

Merged
merged 1 commit into from
Nov 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Example of usage:
`add expense KFC lunch a/10.50 d/28/10/2024 c/FOOD`

Note:
* If the description contains words that start with `a/` or `d/` or `c/`, use capital letters (`A/` or `B/` or `C/`) to prevent invalid error
* Try not to use `|` or `/` in the description. Refer to [descriptions](#1-descriptions) section on how to safely use `|` or `/` in the description.
* If multiple valid `amount`/`date`/`category` are entered, the last valid parameter will be used.
* The remaining budget, after deducting the added expense, will be displayed.
* If the expense causes the budget to be exceeded, a warning message will alert the user.
Expand Down Expand Up @@ -323,6 +323,7 @@ Example of usage:
`add income Tesla stock dividend a/10.50 d/28/10/2024`

Note:
* Try not to use `|` or `/` in the description. Refer to [descriptions](#1-descriptions) section on how to safely use `|` or `/` in the description.
* If multiple valid `amount`/`date` are entered, the last valid parameter will be used.

Expected Usage of Feature:
Expand Down Expand Up @@ -448,6 +449,8 @@ Format: `help`
---

### 1. Descriptions
If the description contains words that start with `a/` or `d/` or `c/`, use capital letters (`A/` or `B/` or `C/`) to prevent invalid error

For features that requires descriptions, avoid using `|` for description as there can be some unintended results. <br>
E.g. Taking this command as example: `add expense hi | Bye a/100 d/10/10/2026`. <br>
This will create a warning as shown below next time the program is started up: ![UserWarning](images/UserWarning.png)
Expand Down
Loading