[CS2113T-T10-4] MindMyMoney#10
Conversation
Musfirahe0556596
left a comment
Musfirahe0556596
left a comment
There was a problem hiding this comment.
Great diagrams drawn! Some issues to consider!
| #### Current Implementation | ||
| The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure | ||
| to the list. | ||
|  |
There was a problem hiding this comment.
Perhaps there should be an activation bar on the call to the AddCommandInputTest#test(...) method as shown in the screenshot?:
There was a problem hiding this comment.
the return values should include the data type e.g. category: String
There was a problem hiding this comment.
This applies to all the return value
There was a problem hiding this comment.
Would it be possible to enter the objectName:Datatype format for the return types?
| 4. During the execution, `Addcommand.execute` will parse through user input to obtain the `EXPENDITURE`, `CATEGORY`, | ||
| `DESCRIPTION`, `AMOUNT` and `TIME` fields. | ||
| 5. The `Addcommand` object instantiates a new `Expenditure` object with the aforementioned 5 fields and adds them |
There was a problem hiding this comment.
Perhaps there should be another line to describe what the AddCommandInputTest#test(...) method does?
| To enable users to view their finances in a more meaningfully, MindMyMoney does calculations to present financial data | ||
| that is actionable for the users. | ||
|
|
||
|  |
There was a problem hiding this comment.
Unsure if the gif is supposed to be an indication of 'to be updated' as here it states that the picture is supposed to be a sequence diagram, but no sequence diagram is shown xD.
| ### Command component | ||
| The source can be found in [command](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/command) | ||
|
|
||
|  |
There was a problem hiding this comment.
This diagram is understandable as it shows the different commands available but perhaps an improvement that could be done is to add in the abstract method execute() also to show that all command types have this method in their own classes?
| The Sequence Diagram below shows an example of how the components interact with each other for the scenario | ||
| where the user issues the command`add shoes 100`. | ||
|
|
||
|  |
There was a problem hiding this comment.
Excellent diagram that shows a high-level overview of how the application works. Colouring to differentiate the different components are also good!
There was a problem hiding this comment.
For the sequence diagram, shouldn't the user go to :MMM with thecommand add shoes before the :Ui?
The sequence feels a bit off here
There was a problem hiding this comment.
I think they are trying to illustrate that the user enters the command through :UI, which is then sent to :MMM to handle, which will then parse and do the rest of the sequence.
| <br/> | ||
|
|
||
| ### UI component | ||
| The source code can be found in [Ui.java](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/Ui.java) |
There was a problem hiding this comment.
I like how you guys include the link for source code in the DG
|
|
||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} | ||
| ### Architecture | ||
|  |
There was a problem hiding this comment.
The architecture diagram does not have to connection between Parser and Commands, while the command diagram indicates otherwise.
| ### Command component | ||
| The source can be found in [command](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/command) | ||
|
|
||
|  |
There was a problem hiding this comment.
The activation bar in the sequence diagram for the Command:AddCommand is too long
| To enable users to view their finances in a more meaningfully, MindMyMoney does calculations to present financial data | ||
| that is actionable for the users. | ||
|
|
||
|  |
There was a problem hiding this comment.
I do not know why you guys put loading gif here but I think it should be a sequence diagram
There was a problem hiding this comment.
I thought it was intended but just curious why haha
There was a problem hiding this comment.
Also curious about the loading gif! Is it a picture that was not rendered?
|  | ||
|
|
||
| ## Product scope | ||
| ### Target user profile |
There was a problem hiding this comment.
There is no information in the product scope, non-functional requirement, glossary and instruction for manual testing sections.
| @@ -4,10 +4,150 @@ | |||
|
|
|||
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} | |||
There was a problem hiding this comment.
There is no overview summary of what the software is all about
| <br/> | ||
|
|
||
| ### UI component | ||
| The source code can be found in [Ui.java](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/Ui.java) |
There was a problem hiding this comment.
It's good that there's a source code hyperlink to the Github website
|  | ||
| <br/> Fig 4 - Parser Diagram | ||
|
|
||
| The Parser component consists of a`Parser`, `Functions`, `ExpenditureList` and `Expenditure`class |
There was a problem hiding this comment.
The labeling of figures may be better if placed above the diagram itself.
Why is the Function class separate from the Parser Class?
|  | ||
|
|
||
| ## Product scope | ||
| ### Target user profile |
There was a problem hiding this comment.
Target User is unknown so it is unclear who this software is for
| To enable users to view their finances in a more meaningfully, MindMyMoney does calculations to present financial data | ||
| that is actionable for the users. | ||
|
|
||
|  |
There was a problem hiding this comment.
Calculate command sequence diagram is not loading maybe because it is a .gif instead of a .png image
|  | ||
| <br/> Fig 2 - Sequence Diagram | ||
|
|
||
| The sections below give more details for each component. |
There was a problem hiding this comment.
There is no termination, loop, opt, etc. in the sequence diagram
| The Sequence Diagram below shows an example of how the components interact with each other for the scenario | ||
| where the user issues the command`add shoes 100`. | ||
|
|
||
|  |
There was a problem hiding this comment.
For the sequence diagram, shouldn't the user go to :MMM with thecommand add shoes before the :Ui?
The sequence feels a bit off here
| The source can be found in [`command`](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/command) | ||
|
|
||
|  | ||
| Fig 5 - Command Class Diagram |
There was a problem hiding this comment.
Might want to centralise the "figure 5". I took a while to find it
| #### Current Implementation | ||
| The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure | ||
| to the list. | ||
|  |
There was a problem hiding this comment.
the return values should include the data type e.g. category: String
| #### Current Implementation | ||
| The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure | ||
| to the list. | ||
|  |
There was a problem hiding this comment.
This applies to all the return value
| To enable users to view their finances in a more meaningfully, MindMyMoney does calculations to present financial data | ||
| that is actionable for the users. | ||
|
|
||
|  |
There was a problem hiding this comment.
I thought it was intended but just curious why haha
| The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure | ||
| to the list. | ||
|
|
||
|  |
There was a problem hiding this comment.
for the print added expenditure, should it be calling the print()/equivilent print method?
| |Version| As a ... | I want to ... | So that I can ...| | ||
| |--------|----------|---------------|------------------| | ||
| |v1.0|new user|see usage instructions|refer to them when I forget how to use the application| | ||
| |v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list| |
There was a problem hiding this comment.
Might want to add more of the user stories, feels like the app has very limited features
FTang21
left a comment
FTang21
left a comment
There was a problem hiding this comment.
Overall really good DeveloperGuide! Good job
|
|
||
| The sequence diagram below shows the interactions of when an `AddCommand` is parsed. | ||
|
|
||
|  |
There was a problem hiding this comment.
| ### Command component | ||
| The source can be found in [`command`](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/command) | ||
|
|
||
|  |
There was a problem hiding this comment.
| The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure | ||
| to the list. | ||
|
|
||
|  |
There was a problem hiding this comment.
| |Version| As a ... | I want to ... | So that I can ...| | ||
| |--------|----------|---------------|------------------| | ||
| |v1.0|new user|see usage instructions|refer to them when I forget how to use the application| | ||
| |v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list| |
There was a problem hiding this comment.
Like ibrahimisramos stated, adding more user stories would be good. It would also tell others what features you focus based on the user stories you looked at or plan to look at.
| The Sequence Diagram below shows an example of how the components interact with each other for the scenario | ||
| where the user issues the command`add shoes 100`. | ||
|
|
||
|  |
There was a problem hiding this comment.
No critique here, just a really nice diagram sequence that details the architecture of your program!
mathanmahe
left a comment
mathanmahe
left a comment
There was a problem hiding this comment.
Looks good. It's a very informative developer guide with a few areas for improvement,
| The Sequence Diagram below shows an example of how the components interact with each other for the scenario | ||
| where the user issues the command`add shoes 100`. | ||
|
|
||
|  |
There was a problem hiding this comment.
I think they are trying to illustrate that the user enters the command through :UI, which is then sent to :MMM to handle, which will then parse and do the rest of the sequence.
| The Sequence Diagram below shows an example of how the components interact with each other for the scenario | ||
| where the user issues the command`add shoes 100`. | ||
|
|
||
|  |
There was a problem hiding this comment.
Good use of color schemes to make the sequence and architecture diagrams more visually appealing and easy to follow through!
| ### Parser component | ||
| The source code can be found in [`Parser.java`](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/Parser.java) | ||
|
|
||
|  |
There was a problem hiding this comment.
Would it be possible to clarify this diagram? It is a bit confusing because a package named Parser is used. But the code architecture does not have a package named parser. Would it be possible to rename it to a more suitable name like ExpenditureTracker? Because it houses not only parser, but also the other aspects like the ExpenditureList, Functions as well as Parser
| #### Current Implementation | ||
| The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure | ||
| to the list. | ||
|  |
There was a problem hiding this comment.
Would it be possible to enter the objectName:Datatype format for the return types?
| **Value proposition** | ||
| Manage finances containing multiple payment methods faster than a typical mouse/GUI driven app. | ||
|
|
||
| ### User Stories |
There was a problem hiding this comment.
Would it be possible to add more user stories that could cover what kind of users the features are intended for?
| To enable users to view their finances in a more meaningfully, MindMyMoney does calculations to present financial data | ||
| that is actionable for the users. | ||
|
|
||
|  |
There was a problem hiding this comment.
Also curious about the loading gif! Is it a picture that was not rendered?
| * Mainstream OS: Windows, Linux, Unix, OS-X | ||
|
|
||
| ## Instructions for manual testing | ||
|
|
There was a problem hiding this comment.
Kindly do add instructions for manual testing of the features so a new developer can understand how to test these features. You can include positive and negative test cases, expected outcomes.
Add Kit Han PPP
Update PPP
Update AboutUs Portfolio link
Sean tests
Sean-PPP pic changes
Add CalculateInputCommand sequence diagrams Refactor and shift helper methods to helper class
# Conflicts: # docs/DeveloperGuide.md # docs/puml/AddExpenditureCommandSequenceDiagram.puml # src/main/java/seedu/mindmymoney/command/AddCommand.java
Fix add command where invalid input crashes program
# Conflicts: # docs/images/AddCreditCardSequenceDiagram.png # docs/images/AddExpenditureSequenceDiagram.png
Standardise sequence and class diag format
Sean bugs lessthan 1hr to deadline
Add validators for reading save file
fixed bug of startwith
…into kitHan-setMaxIncomeAmount
Kit han set max income amount
change dan face pt 2
Minor changes to command classes
12 participants
MindMyMoney is a Command-Line application that allows users to track their spending