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

Developer guide #302

Merged
merged 2 commits into from
Nov 8, 2021
Merged

Developer guide #302

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e93c9a
Merge remote-tracking branch 'upstream/master' into developer-guide
AnShengLee Nov 8, 2021
f0527ed
Update developer guide
AnShengLee Nov 8, 2021
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
3 changes: 2 additions & 1 deletion docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,11 +363,12 @@ shown to the user.
12. Check if the first line of the `csv` file has the correct header. If the header is not correct, a warning will be
shown to the user.
13. Read from the `csv` file line by line.
14. For every line, `x`, 2 things can happen (they will not happen concurrently):
14. For every line, `x`, 3 things can happen (they will not happen concurrently):
- If `x` can be loaded as an `Expense` entry, `DataConverter` will convert it to an `Expense` and load it into
`FinancialTracker`. Start reading for the next line.
- If `x` can be loaded as an `Income` entry, `DataConverter` will convert it to an `Income` and load it into
`FinancialTracker`. Start reading for the next line.
- If `x` is invalid, it will not be loaded in, considered corrupted.
15. If there are corrupted entries (cannot be loaded as `Expense` or `Income`), a warning will be
shown to the user.
16. Return the control to caller.
Expand Down