-
Notifications
You must be signed in to change notification settings - Fork 248
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.
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
[CS2113-W15-1] LifeTracker #94
base: master
Are you sure you want to change the base?
[CS2113-W15-1] LifeTracker #94
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, the DG is easy to understand
docs/DeveloperGuide.md
Outdated
|
||
### Storage Component | ||
|
||
![storage-class-diagram](./uml/storage-class-diagram.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Storage Class diagram is not working
docs/DeveloperGuide.md
Outdated
|
||
## Glossary | ||
|
||
* *glossary item* - Definition | ||
___ | ||
##Instructions for manual testing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe could give more detailed instructions for manual testing
docs/DeveloperGuide.md
Outdated
The user chooses to update his weight by inputting the number `2`. This causes the state of the user's details to be | ||
modified and the user's weight as well as his caloric limit will be updated in accordance to the new weight entered. | ||
|
||
> Insert UML diagram showing the update process |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just note that perhaps y'all have yet to add this diagram in
_LifeTracker_ can also keep track of the exercises that users have done and factor it in to their daily calories lost. This allows | ||
the user to keep track of their net calorie gain on a daily basis. | ||
|
||
### User Stories |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
DGs look well thought of and designed! Good job!
docs/uml/DeleteMealCommand1.png
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very simple, concise and neat. It is easy to understand as it covers the essential commands and classes required.
docs/uml/storage-class-diagram.PNG
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the line leading to the interface supposed to turn into a solid line?
docs/uml/ViewUserCommandSD3.png
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this PowerPoint? I think prof might want us to use plantUML.
docs/uml/ViewUserCommandSD1.png
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would the use of different commands to get to different functions mean parallel paths?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some bugged images and UML notation errors
docs/DeveloperGuide.md
Outdated
|
||
![](../out/docs/uml/Architecture/architecture.svg) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Architecture diagram does not show on the DG
docs/DeveloperGuide.md
Outdated
|
||
### Storage Component | ||
|
||
![storage-class-diagram](./uml/storage-class-diagram.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Class diagram image is broken on the DG
docs/DeveloperGuide.md
Outdated
with the current user and meal storage state. `user` and `meals` will point to the user storage and meal state | ||
respectively. | ||
|
||
<img src="uml/ViewUserCommandSD1.png" alt="Sequence Diagram 1" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Incorrect use of the par frame, the program does not seem to implement multi-threading through the Thread class or Runnable interface.
This calls the getter method `getWeight()` in the entity `User` to return the current weight of the user | ||
and initializes the variable `weight` with that value. | ||
|
||
<img src="uml/ViewUserCommandSD2.png" alt="Sequence Diagram 2" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The label for the "alt" frame should have the diagonal "folded in" bottom right corner (same for opt and par frames)
docs/DeveloperGuide.md
Outdated
by inputting the number `6`. This calls the getter method `getCaloricLimit()` in the entity `User` to return the | ||
current daily caloric limit of the user and initializes the variable `caloricLimit` with that value. | ||
|
||
<img src="uml/ViewUserCommandSD3.png" alt="Sequence Diagram 2" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you want to split the alt frame into multiple diagrams, use reference frames to indicate on the higher level sequence diagram where the new diagram is in the sequence.
docs/DeveloperGuide.md
Outdated
|
||
### Storage Component | ||
|
||
![storage-class-diagram](./uml/storage-class-diagram.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Storage class is not showing up
|
||
{Describe the target user profile} | ||
<img src="uml/DeleteMealCommand1.png" alt="Sequence Diagram" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/DeveloperGuide.md
Outdated
___ | ||
##Instructions for manual testing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/DeveloperGuide.md
Outdated
by inputting the number `6`. This calls the getter method `getCaloricLimit()` in the entity `User` to return the | ||
current daily caloric limit of the user and initializes the variable `caloricLimit` with that value. | ||
|
||
<img src="uml/ViewUserCommandSD3.png" alt="Sequence Diagram 2" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- The
alt
label should have the bottom right corner folded in - It is unclear what the
["6"]
refer to (there is also no step 6 listed) - It seems that
getCaloricLimit()
needs to be run beforeshowDailyCalorieLimit
, then they should not be run in parallel - The arrow of the self invocation for
print out daily calorie limit
should point to the start of its activation bar - In the image, your textbox for
showDailyCalorieLimit
is selected
1. Using a one-line command in their CLI in the format `add [DATE] /on [MEAL_TYPE] /type [FOOD_INDEX] /foods` | ||
2. Typing `add` into the CLI and following the printed prompts to enter the date in the specified format, type of meal and specific food. | ||
|
||
<img src="uml/AddMealCommand1.png" alt="Sequence Diagram" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- It is unclear what your alt conditions are referring to (your explanations do not mention what is
full command
) - Alt label bottom right corner not folded in
- Self invocation arrow not pointing at start of activation bar
- Does your
AddMealCommand
go ahead with creating a newMeal
even whenuserInput
is neitherfull command
noradd
?
docs/DeveloperGuide.md
Outdated
with the current user and meal storage state. `user` and `meals` will point to the user storage and meal state | ||
respectively. | ||
|
||
<img src="uml/ViewUserCommandSD1.png" alt="Sequence Diagram 1" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Are you sure the
User
andCalorieUi
classes are only created when this command is run?
Implemented logger & added logging
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally, good job! Can consider using plantUML for sequence diagrams and give example inputs and explain the steps using those examples.
docs/DeveloperGuide.md
Outdated
|
||
### Storage Component | ||
|
||
![storage-class-diagram](./uml/storage-class-diagram.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Using a one-line command in their CLI in the format `add [DATE] /on [MEAL_TYPE] /type [FOOD_INDEX] /foods` | ||
2. Typing `add` into the CLI and following the printed prompts to enter the date in the specified format, type of meal and specific food. | ||
|
||
<img src="uml/AddMealCommand1.png" alt="Sequence Diagram" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/DeveloperGuide.md
Outdated
|
||
<img src="uml/AddMealCommand1.png" alt="Sequence Diagram" width="500"> | ||
|
||
Step 1. As seen from the sequence diagram above, when the AddMealCommand is executed via the `execute` method in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps giving an example input and showing it in the steps might help readers understand it better.
1. Using a one-line command in their CLI in the format `add [DATE] /on [MEAL_TYPE] /type [FOOD_INDEX] /foods` | ||
2. Typing `add` into the CLI and following the printed prompts to enter the date in the specified format, type of meal and specific food. | ||
|
||
<img src="uml/AddMealCommand1.png" alt="Sequence Diagram" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Arrow from User to :AddMealCommand is missing a name for method call which is execute().
1. Using a one-line command in their CLI in the format `add [DATE] /on [MEAL_TYPE] /type [FOOD_INDEX] /foods` | ||
2. Typing `add` into the CLI and following the printed prompts to enter the date in the specified format, type of meal and specific food. | ||
|
||
<img src="uml/AddMealCommand1.png" alt="Sequence Diagram" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be helpful to explain the functions in the alt portion.
|
||
{Describe the target user profile} | ||
<img src="uml/DeleteMealCommand1.png" alt="Sequence Diagram" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The arrow head for the return dotted line is not visible.
docs/DeveloperGuide.md
Outdated
with the current user and meal storage state. `user` and `meals` will point to the user storage and meal state | ||
respectively. | ||
|
||
<img src="uml/ViewUserCommandSD1.png" alt="Sequence Diagram 1" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Par frame should not be used as program is not multi-threaded.
docs/DeveloperGuide.md
Outdated
by inputting the number `6`. This calls the getter method `getCaloricLimit()` in the entity `User` to return the | ||
current daily caloric limit of the user and initializes the variable `caloricLimit` with that value. | ||
|
||
<img src="uml/ViewUserCommandSD3.png" alt="Sequence Diagram 2" width="500"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/DeveloperGuide.md
Outdated
- Prefers typing to mouse interactions | ||
- Is reasonably comfortable using CLI apps | ||
|
||
### Value proposition: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Value proposition sounds interesting!
_LifeTracker_ can also keep track of the exercises that users have done and factor it in to their daily calories lost. This allows | ||
the user to keep track of their net calorie gain on a daily basis. | ||
|
||
### User Stories |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please check the formats in intelliJ before merging it.
added MingEn82 PPP pdf
Branch debugging
Add Motivational exercise message Feature
Add Target Weight Feature
Branch mustafa
Branch fix target
Add meal exercises examples
Fix gradle errors
update DG manual testing section and PPP
fixed table in UG
fixed typo
updated about us page
Branch hamada
No description provided.