Update UG and fix minor bugs #119
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NeoMinWei
approved these changes
Oct 28, 2023
docs/DeveloperGuide.md
Outdated
| the data one upon exiting the program with the `exit` command. | ||
| * Saving the data once upon exit (Currently implemented): | ||
| * Advantage: Better efficiency and performance of the program. | ||
| * Disadvantage: If the program crashes or is exit incorrectly, data will not be saved. |
There was a problem hiding this comment.
"exited" !!!!!!!!!
or "crashes or exits" !!!!
There was a problem hiding this comment.
💀 i changed it to the second one
wwweert123
approved these changes
Oct 28, 2023
| @@ -48,6 +48,17 @@ API: `Storage.java` | |||
| * The `load` method in LoadData reads the `data.txt` file and loads any existing Income, Expense and Budget into the application. | |||
| * The `save` method in SaveData saves all Incomes, Expenses and existing Budget into the `data.txt` file. | |||
|
|
|||
| #### Design considerations: | |||
There was a problem hiding this comment.
Good clarification of our design consideration
| @@ -2,7 +2,9 @@ | |||
|
|
|||
| ## Introduction | |||
|
|
|||
| {Give a product intro} | |||
| Financial Planner is a Command Line Interface (CLI) application for managing your finances conveniently. | |||
There was a problem hiding this comment.
UserGuide looks very good!
Shall we add a table of contents?
| @@ -8,8 +8,8 @@ Class Storage | |||
| Class "{abstract}\nLoadData" as LoadData | |||
| Class "{abstract}\nSaveData" as SaveData | |||
| Class CashflowList | |||
| Class Budget | |||
| Class Cashflow | |||
| Class "{abstract}\nBudget" as Budget | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #121