Skip to content

Commit

Permalink
Merge pull request CS2103-AY1819S2-W15-2#284 from jhocx/v1.4
Browse files Browse the repository at this point in the history
V1.4 Johnson Documentation
  • Loading branch information
jamessspanggg authored Apr 15, 2019
2 parents 6101335 + 0f03031 commit 510c475
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 10 deletions.
12 changes: 8 additions & 4 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,9 @@ The purpose of this feature is to provide the convenience for users by adding ou

===== Current Implementation

Below is a step-by=step explanation of an example usage scenario for `convertrecurring`.
Below is the UML sequence diagram and a step-by-step explanation of an example usage scenario for `convertrecurring`.

image::ConvertRecurringSequenceDiagram.png[width="800"]

1. User enters the command `convertrecurring`, to add outstanding expenses from all their recurring expenses into the expense list. This command is executed by `LogicManager`, which calls `FinanceTrackerParser#parseCommand("convertrecurring")`. This creates a `ConvertRecurringToExpenseCommand` object and returned to the `LogicManager`.

Expand All @@ -414,11 +416,13 @@ Below is a step-by=step explanation of an example usage scenario for `convertrec

8. This is done for each recurring in the list.

=== Delete and Edit Recurring deletes the associated Expense (coming in v1.4)
==== Advanced Delete and Edit Recurring (coming in v2.0)

This is still a work in progress. +
This is still a work in progress.

Currently, `deleterecurring` does not delete expenses already added by the deleted recurring, and `editrecurring` does not edit expenses already added by the edited recurring. +

The purpose of this feature is to delete or edit expenses already added by a recurring that the user wishes to delete or edit.
The purpose of this feature is to make `deleterecurring` and `editrecurring` more advanced such that the expenses already added by the recurring to be deleted or edited will also reflect the new changes. +

// end::recurring[]

Expand Down
20 changes: 19 additions & 1 deletion docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@ Want to keep track of monthly bills in the expense tracker as well? +
The Recurring feature simplifies the process of adding periodic expenses such as phone bills or Netflix subscriptions. +
Instead of manually adding the same expense repetitively, just add a Recurring and the Finance Tracker will automatically
add the expense for you periodically at your specified frequency and for your specified duration! +
The Recurring feature also simplifies the deletion and editing of these recurring expenses!

=== Stats
Want to see trends and statistics of your expenses? +
Expand Down Expand Up @@ -473,6 +472,23 @@ Examples:
`deleterecurring 2` +
Deletes the 2nd recurring in the finance tracker.

=== Selecting a recurring : `selectrecurring`

Select the specified recurring from the finance tracker. +
Format: `selectrecurring INDEX` +
Shortcut: `sr INDEX`

====
* Selects the recurring at the specified `INDEX`.
* The index refers to the index number shown in the displayed recurring list. The index must be a positive integer.
====

Examples:

* `listrecurring v/all` +
`selectrecurring 2` +
Selects the 2nd recurring in the finance tracker.

=== Clearing all recurrings: `clearrecurring`

Clears all recurrings from the finance tracker. +
Expand Down Expand Up @@ -760,6 +776,8 @@ e.g. `editrecurring 9 $/450 c/food` +
e.g. `deleterecurring 2` +
* *Converting outstanding expenses from all recurrings* : `convertrecurring` +
e.g. `convertrecurring` +
* *Select a recurring* : `selectrecurring INDEX` +
e.g. `selectrecurring 1`
* *Clear recurrings* : `clearrecurring`
* *Viewing Statistics - Summary:* `stats [sd/START_DATE] [ed/END_DATE]` +
e.g. `stats sd/01-01-2019 ed/01-02-2019`
Expand Down
Binary file not shown.
Binary file added docs/images/ConvertRecurringSequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 8 additions & 5 deletions docs/team/jhocx.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ Personal Finance Tracker is a desktop finance tracker application used for track
== Summary of contributions

* *Major enhancement*: added *the ability to manage recurring expenses in the finance tracker application*
** What it does: allows the user to add, edit, delete recurrings, as well as easily convert these recurrings into an expense at appropriate times. Integrated to work with current undo/redo, history and list commands.
** What it does: allows the user to add, edit, delete recurring expenses, as well as easily convert these recurring expenses into expenses at appropriate times. Integrated to work with current undo/redo, history and list commands.
** Justification: This feature improves the product significantly because a user can now easily and conveniently keep track of their recurring expenses, expenses that are periodic and have a fixed frequency and a defined number of occurrences. Examples of these recurring expenses are bills or subscription fees.
** Highlights: This enhancement is a core feature of any typical finance tracker. It required adjustments and integration with the existing model, logic, UI components and builds the foundation for any future enhancements involving recurring expenses.
** Highlights: Recurring expenses form a significant portion of a user's expenses and thus tracking recurring expenses is a core feature of a finance tracker. It required adjustments and integration with the existing model, logic, UI components and builds the foundation for any future enhancements involving recurring expenses.

* *Code contributed*: [https://nus-cs2103-ay1819s2.github.io/cs2103-dashboard/#search=jhocx&sort=displayName&since=2019-02-10&until=2019-03-26&timeframe=day&reverse=false&repoSort=true[code collated by reposense]]
* *Code contributed*: [https://nus-cs2103-ay1819s2.github.io/cs2103-dashboard/#search=jhocx&sort=displayName&since=2019-02-10&until=2019-04-10&timeframe=day&reverse=false&repoSort=true[code collated by reposense]]

* *Other contributions*:

Expand All @@ -29,8 +29,11 @@ Personal Finance Tracker is a desktop finance tracker application used for track
*** In charge of code in storage component
** Documentation:
*** Update storage component in Developer's Guide
*** Added the implementation of recurrings in Developer's Guide
*** In charge of UserGuide in general.
*** Added the implementation of recurrings in Developer's Guide (Pull Request https://github.com/CS2103-AY1819S2-W15-2/main/pull/227[#227])
*** In charge of UserGuide in general. (Pull Request https://github.com/CS2103-AY1819S2-W15-2/main/pull/227[#227])
** Enhancement to existing features:
*** Refactored code to transform from AddressBook4 to FinanceTracker. (Pull Request https://github.com/CS2103-AY1819S2-W15-2/main/pull/69/[#69])
*** Refactored code in storage to transform from AddressBook4 to FinanceTracker. (Pull Request https://github.com/CS2103-AY1819S2-W15-2/main/pull/66[#66])

== Contributions to the User Guide

Expand Down

0 comments on commit 510c475

Please sign in to comment.