[CS2113-F15-2] LifeTrack #56
Conversation
Added asserts for own components
Fix bug with give-summary command
docs/DeveloperGuide.md
Outdated
|
|
||
| The Class diagram for Calories list feature is shown below. Unrelated attributes and Classes were excluded. | ||
|
|
||
|  |
There was a problem hiding this comment.
Could use these proper symbols for representing public/private classes instead of squares
- : public
- : private
: protected
~ : package private
docs/DeveloperGuide.md
Outdated
|
|
||
| The Class diagram for Calories delete feature is shown below: | ||
|
|
||
|  |
There was a problem hiding this comment.
Diagram has formatting issues and does not show up as a picture
docs/HydrationDeleteDiagram.png
Outdated
There was a problem hiding this comment.
add a end of lifeline "X" after entry deleted
docs/HydrationDeleteDiagram.png
Outdated
There was a problem hiding this comment.
Change the # to :
Should be Ui:handleUserInput()
| - Step 5: The latest hydration list will be updated to saving file by calling `HydrationList#updateFile()`. | ||
|
|
||
| The Sequence diagram for Hydration delete feature is shown below: | ||
|  | ||
|
|
||
| ## Product scope | ||
| ### Target user profile |
There was a problem hiding this comment.
Could fill in information on scope, user profile etc
| * @return an Entry object representing calorie intake | ||
| * @throws InvalidInputException if the input string is missing components or contains empty fields | ||
| */ | ||
| public static Entry parseCaloriesInput(String input) throws InvalidInputException { |
There was a problem hiding this comment.
Perhaps can refactor this method more? It seems too wordy.
docs/CaloriesAddEntrySeqDiagram.png
Outdated
There was a problem hiding this comment.
After the updateFile(), from the code it seems like it calls fileHandler in the storage. Perhaps can show the storage class too?
docs/HydrationListClassDiagram.png
Outdated
There was a problem hiding this comment.
Should there be a "C" beside your classes?
docs/HydrationListClassDiagram.png
Outdated
There was a problem hiding this comment.
Are the symbols used to represent "private" and "public" methods correct?
docs/caloriesDeleteUML.jpg
Outdated
There was a problem hiding this comment.
Perhaps can standardise the class diagrams? Some diagrams have colour some doesn't.
docs/DeveloperGuide.md
Outdated
|
|
||
| The Class diagram for Calories delete feature is shown below: | ||
|
|
||
|  |
There was a problem hiding this comment.
This diagram does not show. It doesn't seem to appear in the docs package as well.
docs/HydrationDeleteDiagram.png
Outdated
There was a problem hiding this comment.
This sequence diagram looks different from the previous diagram. Perhaps can standardise it?
docs/DeveloperGuide.md
Outdated
|
|
||
| The sequence diagram for this feature is shown below: | ||
|
|
||
|  |
There was a problem hiding this comment.
There appears to be some self-called methods in ParserCalories#parseCaloriesInput() such as checkKeyWordExists(), checkKeywordsCorrectlyOrdered() etc. Would it be better to include these self called methods into the diagram?
docs/DeveloperGuide.md
Outdated
| #### Design considerations | ||
|
|
||
| - **Alternative 1 (current choice):** Uses an API to get the calories needed | ||
| - Pros: No need to figure out the optimal algorithm | ||
| - Cons: Need to parse response to sieve out necessary information | ||
|
|
||
| - **Alternative 2:** Uses an algorithm to find the number of calories needed | ||
| - Pros: Not dependent on external APIs | ||
| - Cons: Need to come up with an algorithm to use |
There was a problem hiding this comment.
Great indication of other design considerations. The implementation for this feature is clearly stated and easy to follow. Would it be better to also include a sequence diagram to trace the code?
docs/DeveloperGuide.md
Outdated
|
|
||
| The Class diagram and sequence diagram for Calories list feature is shown below. Unrelated attributes and Classes were excluded. | ||
|
|
||
|  |
There was a problem hiding this comment.
Good job on using a Class Diagram here. It serves a good purpose for this feature. However, the notation regarding the calories and calorieslist does not seem to be a notation used in CS2113T. Would it be better to use the association lines instead?
docs/DeveloperGuide.md
Outdated
|
|
||
| The Class diagram for Calories delete feature is shown below: | ||
|
|
||
|  |
There was a problem hiding this comment.
The diagram does not seem to appear correctly in the Developer Guide. Would it be better to update the link to a relative path in the code, e.g. "caloriesDeleteUML.jpg" instead of the github link?
docs/DeveloperGuide.md
Outdated
|
|
||
| The Class diagram for Hydration list feature is shown below. Unrelated attributes and Classes were excluded. | ||
|
|
||
|  |
There was a problem hiding this comment.
The association between hydration and hydrationlist does not seem to be a notation used in cs2113. Would it be better to update the diagram to use association lines instead?
docs/DeveloperGuide.md
Outdated
| - Step 5: The latest hydration list will be updated to saving file by calling `HydrationList#updateFile()`. | ||
|
|
||
| The Sequence diagram for Hydration delete feature is shown below: | ||
|  |
There was a problem hiding this comment.
The notation for this sequence diagram appears to be different from the rest of the diagrams. The methods called seem to be indicated with the class. E.g. Ui#handleHydrationinput. Would it be better to standardize the notations to match the previous diagrams, in particular, following the notation taught during lectures?
|
|
||
| - Step 5: The latest hydration list will be updated to saving file by calling `HydrationList#updateFile()`. | ||
|
|
||
| The Sequence diagram for Hydration delete feature is shown below: |
There was a problem hiding this comment.
Great Job at keeping the application used to make the sequence diagrams the same.
docs/UserGuide.md
Outdated
| **Format:** | ||
| `calories list` | ||
|
|
||
| #### Sample output |
There was a problem hiding this comment.
It's good to tell the user about what they can potentially get.
docs/UserGuide.md
Outdated
| @@ -37,6 +235,17 @@ Example of usage: | |||
|
|
|||
| ## Command Summary | |||
|
|
|||
| {Give a 'cheat sheet' of commands here} | |||
|
|
|||
| | Action | Format, Examples | | |||
There was a problem hiding this comment.
Good, a help function can always help the user when they get lost.
| {Give a product intro} | ||
| LifeTrack is a desktop app for students to track their health data, optimized for use via a Command Line Interface (CLI). It tracks calories, hydration and sleep data for the user, while also providing daily recommendations for calorie and hydration intake, based on the user's build and gender, as well as their body goals and activity levels. | ||
|
|
||
| ## Quick links |
| - Step 5: The latest hydration list will be updated to saving file by calling `HydrationList#updateFile()`. | ||
|
|
||
| The Sequence diagram for Hydration delete feature is shown below: | ||
|  | ||
|
|
||
| ## Product scope | ||
| ### Target user profile |
There was a problem hiding this comment.
Users have various reasons to choose your product, maybe have more lines and contents for user stories?
docs/CaloriesAddEntrySeqDiagram.png
Outdated
There was a problem hiding this comment.
Is it possible to make the bar thicker, it's kinda hard to distinguish the bars when classes are calling multiple functions inside the class.
| - `ParserCalories#parseCaloriesInput(String)` | ||
| - `FileHandler#updateFile()` | ||
|
|
||
| This feature is activated when the user inputs a `calories in` or `calories out` command in the terminal. |
docs/DeveloperGuide.md
Outdated
| - Step 5: The latest sleep list will be updated to saving file by calling `SleepList#updateFile()`. | ||
|
|
||
| The Sequence diagram for Sleep delete feature is shown below: | ||
|  |
There was a problem hiding this comment.
The image of the sequence diagram is not rendered correctly.
docs/DeveloperGuide.md
Outdated
|
|
||
| The Class diagram for Hydration list feature is shown below. Unrelated attributes and Classes were excluded. | ||
|
|
||
|  |
docs/DeveloperGuide.md
Outdated
|
|
||
| The sequence diagram for this feature is shown below: | ||
|
|
||
|  |
There was a problem hiding this comment.
Remember to add colon ':' in front of all instances of a class.
|
|
||
| #### Implementation | ||
|
|
||
| This functionality is facilitated by `UI`, `SleepList`, `FileHandler` and `ParserSleep`. It implements one operation, namely: |
There was a problem hiding this comment.
Good job with the implementation!
There was a problem hiding this comment.
Hi team,
Good job at making the DG!
Take note of these general comments:
- Please take note of the syntax issues with the diagrams. Standardize your diagram tools.
- There are some sections of the DG that are incomplete. Please finish them.
- The parts where design considerations were added is good. Don't forget to include design considerations and the design of the feature itself (class diagram) as sections.
- Upload your diagrams as files, do not use Github blobs (copy paste directly into the Github code editor).
You may refer to the AB3 DG as reference on how a well structured DG looks like as you fix your DG and add more diagrams/content.
docs/DeveloperGuide.md
Outdated
| @@ -5,9 +5,238 @@ | |||
| {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.
This should be at the bottom; and it is not complete
| @@ -5,9 +5,238 @@ | |||
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} | |||
|
|
|||
|
|
||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} | ||
| #### Implementation |
There was a problem hiding this comment.
Good that you zoomed into implementation via the header. What happened to the Design part?
docs/DeveloperGuide.md
Outdated
|
|
||
| The sequence diagram for this feature is shown below: | ||
|
|
||
|  |
There was a problem hiding this comment.
As a peer mentioned, you are missing the colon.
The actor Bob is a good adition, but is Bob really a good way of describing a User?
| @@ -5,9 +5,238 @@ | |||
| {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.
For all your images, save it as a proper file inside your docs folder. Avoid copy pasting and letting Github render from blobs. This will help in version control as well.
docs/DeveloperGuide.md
Outdated
| - Step 5: The latest hydration list will be updated to saving file by calling `HydrationList#updateFile()`. | ||
|
|
||
| The Sequence diagram for Hydration delete feature is shown below: | ||
|  |
docs/DeveloperGuide.md
Outdated
| - Step 5: `FileHandler#updateFile()` is then called to update the data file with the new entry in the `SleepList`. | ||
|
|
||
| The sequence diagram for this feature is shown below: | ||
|  |
There was a problem hiding this comment.
Standardize the tools used for the diagrams.
A few issues:
- No return from activation bar
-
Return line not starting at end of activation bar.
-
User does not need an activation bar
docs/DeveloperGuide.md
Outdated
| The `printSleepList()` function iterates through the `sleepList` and each entry will call `SleepEntry#toString()` to return its information string to be printed. | ||
|
|
||
| The Sequence diagram for Sleep list feature is shown below. Unrelated attributes and Classes were excluded. | ||
|  |
There was a problem hiding this comment.
Same comments as per the previous seq diagram critique
| The Sequence diagram for Sleep delete feature is shown below: | ||
|  | ||
|
|
||
| ### Calculating sleep requirements for each user (Planning) |
There was a problem hiding this comment.
May want to rephrase as proposed future feature
docs/DeveloperGuide.md
Outdated
| ## Product scope | ||
| ### Target user profile |
# Conflicts: # src/main/java/seedu/lifetrack/calories/calorielist/CalorieList.java
Fix ped bugs
Add sort entries by date feature
…rom empty calorie list
Add bug fixes related to rex
Hydration seq diagram
Add Yanyu's PPP
update ppp
Update UserGuide.md
Update UserGuide.md
Update UserGuide.md
Update AboutUs.md
Update DeveloperGuide.md
LifeTrack is a desktop app for students to track their health data, optimized for use via a Command Line Interface (CLI). LifeTrack is especially catered towards those who can type fast, as they can track their health data much faster than when using traditional Graphical User Interface (GUI) apps.