Skip to content

Commit

Permalink
Merge pull request #215 from jonathantjm/develop
Browse files Browse the repository at this point in the history
Changes in docs
  • Loading branch information
jonathantjm committed Nov 12, 2018
2 parents 53434a1 + 92085da commit 129861a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
13 changes: 6 additions & 7 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,14 @@ with features such as setting a budget and expense statistics, which help you st

The *Expense Tracker Developer Guide* contains all the information you need to start development on Expense Tracker. It
also includes information about the overall architecture and implementation of various features in Expense Tracker.
Whether this is your first project or your 37th project, this guide will help you to start contribute to Expense Tracker.
Jump to <<Setting up, Setting up>> to start setting up your environment.
Whether this is your first project or your 37th project, this guide will help you to start contributing to Expense Tracker.
Jump to <<Setup, Set up>> to start setting up your environment.

[[Setup]]
== Set Up

'''
Follow the steps in the section below to start development on Expense Tracker

'''
Follow the steps in the sections below to start development on Expense Tracker:

=== Prerequisites

Expand Down Expand Up @@ -1950,12 +1949,12 @@ Given below are instructions to test the app manually.
accordingly.
** Test case: `setBudget 0.00` +
Expected: Error message of no negative values being allowed is shown. Budget is not set. UI does not update.
** Test case: `setBudget -1.00`+
** Test case: `setBudget -1.00` +
Expected: Similar to previous
** Test case: `setBudget 1` +
Expected: Budget is not set. Error details stating that the a valid budget consists of {int}.{digit}{digit} is
shown in the status message. UI is not updated.
** Testcase: `setBudget x` where x is not a number` +
** Testcase: `setBudget x`, where x is not a number` +
Expected: Budget is not set. Error message informing user of incorrect syntax is shown in the status message. UI is
not updated.

Expand Down
17 changes: 10 additions & 7 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ This component is highlighted by the red box. There are two modes to this panel:
You are able swap between Expense List mode and Statistics Panel mode by using the `list` command and
`stats` command, respectively.

See <<ListCommand,`list`>> and <<StatsCommand, `stats`>> commands for more details on these commands.
See <<ListCommand,`list`>> and <<StatsCommand, `stats`>> commands for more details on these commands.

==== Expense List mode
In Expense List mode, the Left Panel displays the list of all expenses, as shown below:
Expand All @@ -84,11 +84,11 @@ image::userguide/expenseList.png[width="790"]

Commands that alter the Expense List, such as `find` and `list`, will change the expenses that are shown.

See <<FindCommand, `find`>> and <<ListCommand, `list`>> commands for more details.
See <<FindCommand, `find`>> and <<ListCommand, `list`>> commands for more details.

Each expense has an index number next to the expense name. These are relevant to the `delete` and `edit` commands.

See <<DeleteCommand, `delete`>> and <<EditCommand, `edit`>> commands for more details.
See <<DeleteCommand, `delete`>> and <<EditCommand, `edit`>> commands for more details.


==== Statistics Panel mode
Expand All @@ -101,14 +101,14 @@ The upper section displays statistical information about expenses.

The type of statistics shown can be changed via the `stats` command.

See <<StatsCommand, `stats`>> command for more details.
See <<StatsCommand, `stats`>> command for more details.

The lower section shows four of the category budgets that have been set using the `setCategoryBudget` command.

[NOTE]
If there are no category budgets set, the lower section will be empty, save for the title.

See <<SetCategoryBudgetCommand, `setCategoryBudget`>> command for more details.
See <<SetCategoryBudgetCommand, `setCategoryBudget`>> command for more details.

=== Budget Panel

Expand Down Expand Up @@ -596,13 +596,13 @@ Choosing Time mode will show a bar chart, similar to the one below, in the stati
depending on the specified `PERIOD_AMOUNT` and `PERIOD`, starting from the current day or month. +

.Statistics Panel showing a bar chart in Time mode
image::userguide/barChart.png[width="790"]
image::userguide/barChart.png[width="600"]

Choosing Category mode will show a pie chart, similar to the one below, in the statistics panel, where amounts for each category will displayed for
expenses in the specified `PERIOD_AMOUNT` and `PERIOD`.

.Statistics Panel showing a pie chart in Category mode
image::userguide/pieChart.png[width="790"]
image::userguide/pieChart.png[width="600"]

The available options for `PERIOD` are `d` and `m`, which represents day and month respectively. E.g. if `PERIOD_AMOUNT` is 7
and `MODE` is `d`, the statistics will include data from the past 7 days.
Expand All @@ -619,6 +619,9 @@ Shows the expense statistics for the past 14 days as a bar chart showing expense
* `stats n/3 p/m m/t` +
Shows the expense statistics for the past 3 months as a bar chart showing expenses for each month +
* `stats n/7 p/d m/c` +
Shows the expense statistics for the past 7 days as a pie chart showing expenses for each category +
* `stats n/3 p/m m/c` +
Shows the expense statistics for the past 3 months as a pie chart showing expenses for each category +
****
Expand Down

0 comments on commit 129861a

Please sign in to comment.