Merge pull request #238 from AY1920S1-CS2103T-W12-3/develop-budget

Fix minor errors

Author: yewon0303

docs/UserGuide.adoc

@@ -108,7 +108,9 @@ Examples:
 
 === Setting a Budget : `set`
 
-You can set a budget for a particular category until a certain date, given it is not a duplicate.
+=== Setting a Budget : `set`
+
+You can set a budget for a particular category until a certain date, given it is not already present in the budget list.
 A duplicate budget is a budget with the same `AMOUNT` and `DATE` and `CATEGORY`. +
 If you attempt to do so, you will receive an error message: `This budget already exists in the bank account`. +
 
@@ -118,19 +120,41 @@ Format: `set $/AMOUNT d/DATE c/CATEGORY`
 * `AMOUNT` input accepts the new budget amount to be set. This amount must be non-negative, non-zero and
 less than 1,000,000.
 * `DATE` input accepts the deadline to be set. It cannot be a date in the past.
-* `CATEGORY` accepts the CATEGORY for the budget. A budget can be created without `CATEGORY` inputs.
+* `CATEGORY` accepts the CATEGORY for the budget. A budget can be created without `CATEGORY` inputs in which case, the budget will automatically be assigned `GENERAL' category.
 ****
 
-Example: Let's say you want to restrict your spending for a certain category until a certain deadline.
+Let's say you want to restrict your spending for a certain category until a certain deadline.
 PalPay allows you to set a budget and serve as a reminder to show how much of the budget set you have left
-until the deadline. (V1.4) You will be more self-conscious of your spending and minimise your spending by setting a budget. +
+until the deadline. You will be more self-conscious of your spending and minimise your spending by setting a budget. +
 
 To set a new budget: +
 1. Type `set` and enter the relevant details (amount, deadline, category) in the format given above. +
 2. The result box will display the message "New budget successfully set". +
 3. If the budget already exists in the budget list, the result box will display the message "This budget already exists". +
 4. Now you can see the newly set budget in the budget list.
 
+As you make an *OutTransaction* of a particular `CATEGORY`, your budgets with the same `CATEGORY` will be adjusted
+to display the remaining amount of budget. Other budgets in the list belonging to different `CATEGORY` will not be adjusted. +
+
+If you overspend beyond a set budget, the overspent budget will be displayed in red.
+Shown below as budget index 3 is an example of an overspent budget:
+
+.Overspent Budget
+image::overspentBudget.png[]
+
+As the day you have set for the budget approaches, the countdown placeholder as well as the percentage remaining placeholder
+will turn to red when the number of remaining days reaches 3 and below.
+Shown below as budget index 4 is an example of a budget approaching its deadline:
+
+.Budget approaching deadline
+image::approachingBudget.png[]
+
+Examples:
+
+* `set $/100 d/010120120 c/BBT`
+* `set $/300 d/29022020 c/shopping`
+
+
 === Splitting a Bill with Friends : `split`
 
 Split a bill with your friends +

docs/diagrams/DeleteSequenceDiagram.puml

@@ -48,7 +48,7 @@ deactivate BankAccountParser
 LogicManager -> DeleteCommand : execute()
 activate DeleteCommand
 
-DeleteCommand -> Model : deletePerson(1)
+DeleteCommand -> Model : deleteTransaction(1)
 activate Model
 
 Model --> DeleteCommand

docs/diagrams/LogicClassDiagram.puml

@@ -8,7 +8,7 @@ package Logic {
 
 package Parser {
 Interface Parser <<Interface>>
-Class AddressBookParser
+Class BankAccountParser
 Class XYZCommandParser
 Class CliSyntax
 Class ParserUtil
@@ -35,8 +35,8 @@ Class HiddenOutside #FFFFFF
 HiddenOutside ..> Logic
 
 LogicManager .up.|> Logic
-LogicManager -->"1" AddressBookParser
-AddressBookParser .left.> XYZCommandParser: creates >
+LogicManager -->"1" BankAccountParser
+BankAccountParser .left.> XYZCommandParser: creates >
 
 XYZCommandParser ..> XYZCommand : creates >
 XYZCommandParser ..|> Parser

docs/images/approachingBudget.png

@@ -63,7 +63,7 @@ public CommandResult execute(Model model) throws CommandException {
             ObservableList<Budget> lastShownList = model.getFilteredBudgetList();
 
             if (targetIndex.getZeroBased() >= lastShownList.size()) {
-                throw new CommandException(Messages.MESSAGE_INVALID_TRANSACTION_DISPLAYED_INDEX);
+                throw new CommandException(Messages.MESSAGE_INVALID_BUDGET_DISPLAYED_INDEX);
             }
             //TODO: updateProjectionsAfterDelete(Budget budget)
             Budget budgetToDelete = lastShownList.get(targetIndex.getZeroBased());
@@ -76,7 +76,7 @@ public CommandResult execute(Model model) throws CommandException {
             ObservableList<Projection> lastShownList = model.getFilteredProjectionsList();
 
             if (targetIndex.getZeroBased() >= lastShownList.size()) {
-                throw new CommandException(Messages.MESSAGE_INVALID_TRANSACTION_DISPLAYED_INDEX);
+                throw new CommandException(Messages.MESSAGE_INVALID_PROJECTION_DISPLAYED_INDEX);
             }
 
             Projection projectionToDelete = lastShownList.get(targetIndex.getZeroBased());