Skip to content

[CS2113-W15-1] LifeTracker#94

Open
MingEn82 wants to merge 548 commits into
nus-cs2113-AY2223S2:masterfrom
AY2223S2-CS2113-W15-1:master
Open

[CS2113-W15-1] LifeTracker#94
MingEn82 wants to merge 548 commits into
nus-cs2113-AY2223S2:masterfrom
AY2223S2-CS2113-W15-1:master

Conversation

@MingEn82

Copy link
Copy Markdown

No description provided.

@Geeeetyx Geeeetyx left a comment

Copy link
Copy Markdown

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

Comment thread docs/DeveloperGuide.md Outdated

### Storage Component

![storage-class-diagram](./uml/storage-class-diagram.png)

Copy link
Copy Markdown

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

Comment thread docs/DeveloperGuide.md Outdated

* *glossary item* - Definition
___
##Instructions for manual testing

Copy link
Copy Markdown

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

Comment thread 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

Copy link
Copy Markdown

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

Comment thread docs/DeveloperGuide.md
_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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a bug with your user stories table, it does not show up as intended on the DG website

image

@Khulon Khulon left a comment

Copy link
Copy Markdown

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!

Copy link
Copy Markdown

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.

Copy link
Copy Markdown

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?

Copy link
Copy Markdown

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.

Copy link
Copy Markdown

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?

@waiter-palypoo waiter-palypoo left a comment

Copy link
Copy Markdown

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

Comment thread docs/DeveloperGuide.md Outdated
---
### Architecture

![](../out/docs/uml/Architecture/architecture.svg)

Copy link
Copy Markdown

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

Comment thread docs/DeveloperGuide.md Outdated

### Storage Component

![storage-class-diagram](./uml/storage-class-diagram.png)

Copy link
Copy Markdown

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

Comment thread 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">

Copy link
Copy Markdown

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.

Comment thread docs/DeveloperGuide.md
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">

Copy link
Copy Markdown

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)

Comment thread 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">

Copy link
Copy Markdown

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.

Comment thread docs/DeveloperGuide.md Outdated

### Storage Component

![storage-class-diagram](./uml/storage-class-diagram.png)

Copy link
Copy Markdown

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

Comment thread docs/DeveloperGuide.md
which meal they want to delete by viewing the mealData.csv file.

{Describe the target user profile}
<img src="uml/DeleteMealCommand1.png" alt="Sequence Diagram" width="500">

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to add the deletion of a Meal Object?
image

Comment thread docs/DeveloperGuide.md Outdated
Comment on lines +225 to +226
___
##Instructions for manual testing

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image
Heading formatting is broken due to missing newline between your glossary list and next heading

Comment thread 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">

Copy link
Copy Markdown

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 before showDailyCalorieLimit, 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

Comment thread docs/DeveloperGuide.md
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">

Copy link
Copy Markdown

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 new Meal even when userInput is neither full command nor add?

Comment thread 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">

Copy link
Copy Markdown

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 and CalorieUi classes are only created when this command is run?

kyrixn pushed a commit to kyrixn/tp that referenced this pull request Mar 30, 2023

@YC-Michael YC-Michael left a comment

Copy link
Copy Markdown

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.

Comment thread docs/DeveloperGuide.md Outdated

### Storage Component

![storage-class-diagram](./uml/storage-class-diagram.png)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Storage-class-diagram is not showing up. If you are using plantUML, simply copy paste the image over to your DG from the UML file.

Comment thread docs/DeveloperGuide.md
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">

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The box label for alt should consist of three lines.
image

Comment thread 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

Copy link
Copy Markdown

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.

Comment thread docs/DeveloperGuide.md
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">

Copy link
Copy Markdown

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().

Comment thread docs/DeveloperGuide.md
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">

Copy link
Copy Markdown

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.

Comment thread docs/DeveloperGuide.md
which meal they want to delete by viewing the mealData.csv file.

{Describe the target user profile}
<img src="uml/DeleteMealCommand1.png" alt="Sequence Diagram" width="500">

Copy link
Copy Markdown

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.

Comment thread 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">

Copy link
Copy Markdown

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.

Comment thread 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">

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

When taking a screenshot, do take note of the highlights.

Comment thread docs/DeveloperGuide.md Outdated
- Prefers typing to mouse interactions
- Is reasonably comfortable using CLI apps

### Value proposition:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Value proposition sounds interesting!

Comment thread docs/DeveloperGuide.md
_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

Copy link
Copy Markdown

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.

vishnuvk47 pushed a commit to vishnuvk47/tp that referenced this pull request Mar 31, 2023
MustafaAH10 and others added 30 commits April 10, 2023 14:15
update DG manual testing section and PPP
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.