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.

Sign up for GitHub

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 with budget and help commands #193

Merged
merged 4 commits into from
Oct 23, 2019
Merged

Update UG with budget and help commands #193

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89db979
Merge branch 'master' of https://github.com/AY1920S1-CS2103T-W12-1/main
TanZhanMing Oct 23, 2019
bd5e2b5
Update UG with help and budget commands
TanZhanMing Oct 23, 2019
2d4ce28
Update UG for help and budget commands
TanZhanMing Oct 23, 2019
fb3918b
remove trailing whitespace
TanZhanMing Oct 23, 2019
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
29 changes: 24 additions & 5 deletions docs/UserGuide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,24 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.

=== Viewing help : `help`

Format: `help`
Provides 3 different types of help for all commands.

Keyword: `help`

Format:
`help cmd/COMMAND type/TYPE`

Refer to <<Command Summary>> for all available commands

Types include: +
`brief` (gives a brief description) +
`guide` (opens a web browser and bring you to our user guide) +
`api` (for advanced users who want to know the inner workings of the command) +

Examples: +
`help cmd/add_income type/brief` +
`help cmd/goto type/guide` +
`help cmd/help type/api`

=== Changing Views : `goto`

Expand Down Expand Up @@ -175,7 +192,10 @@ Examples:
* The index *must be a positive integer* 1, 2, 3, ...
****

=== See budget (Pop-up)
=== Viewing budget : `budget`

Calculates the projected budget based on all income and approved claim values. +
Also displays a graph detailing total income, claim and budget values for every day of the current month. +

Format: `budget`

Expand Down Expand Up @@ -262,7 +282,8 @@ Automatically detects command and comes up with suggestions as a pop-up on what

== Command Summary

* *Help* : `help`
* *Help* : `help cmd/COMMAND type/TYPE` +
e.g. `help cmd/add_income type/brief`

* *Changing of Views* `goto (parameter)`
e.g. `goto claims`
Expand Down Expand Up @@ -309,5 +330,3 @@ e.g. `attach 1`
e.g. `tag 1 t/FOP t/Sports`

* *Closing application* `exit`