-
Notifications
You must be signed in to change notification settings - Fork 411
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
[CS2103T-T10-2] DukeCooks #123
base: master
Are you sure you want to change the base?
[CS2103T-T10-2] DukeCooks #123
Conversation
docs/DeveloperGuide.adoc
Outdated
|
||
[discrete] | ||
=== Use case: Delete person | ||
=== Use case: Add recipe |
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.
Consider numbering the use cases: e.g. Use case UC01: Add recipe
@@ -337,17 +339,115 @@ Use case ends. | |||
* 3a. The given index is invalid. |
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.
Should this be generalised such that it doesn't show information about UI?
|
||
[discrete] | ||
=== Use case: Add Calorie Intake | ||
|
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 consider clarifying the information provided in Nutrition (Breakdown)? Its slightly unclear what the list of Nutrition means
+ | ||
Use case ends. | ||
|
||
*Extensions* |
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.
All your extensions are pretty exhaustive, good job!
* prefer desktop apps over other types | ||
* can type fast | ||
* prefers typing over mouse input | ||
* is reasonably comfortable using CLI apps | ||
|
||
*Value proposition*: manage contacts faster than a typical mouse/GUI driven app | ||
*Value proposition*: monitors all aspects of health in one application | ||
|
||
[appendix] | ||
== 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.
Have you considered adding more user stories? Could consider including additional stories that would be possible in v2.0
[none] | ||
** 1a1. DukeCooks displays an error message. | ||
+ | ||
Use case ends. | ||
|
||
[appendix] | ||
== Non Functional Requirements |
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.
Have you considered additional NFRs? For example, having backups in case of data corruption.
docs/DeveloperGuide.adoc
Outdated
|
||
[appendix] | ||
== Non Functional Requirements | ||
|
||
. Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed. | ||
. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. | ||
. Should be able to hold up to 1000 recipes without a significant reduction in performance for typical usage. |
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 you like to consider quantifying the "significant" reduction? This would help identifying whether the goal has been met.
The class diagram below gives an overview of the `Recipe` class. | ||
|
||
.Recipe Class Diagram | ||
image::RecipeClassDiagram.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.
Hi would it be better if the UML diagram has only either associations via the arrows or associations via the attributes?
|
||
.Interactions Inside the Logic Component for the `delete 1` Command | ||
.Interactions Inside the Logic Component for the `delete recipe 1` Command | ||
image::DeleteSequenceDiagram.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.
Would it be better if the sequence diagram had bigger font to allow the reader to see more easily?
docs/DeveloperGuide.adoc
Outdated
|
||
The following sequence diagram shows how the undo operation works: | ||
Step 2. The user executes `add task tn/bake a cake td/12/12/2019` command to add a new | ||
task into Duke Cooks. The `add` command calls `Model#addDashboard()`, causing the task to |
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.
might want to consider splitting this into smaller steps because it looks quite cluttered to the reader in my opinion
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.
Good effort on the diagrams! 👍🏻
docs/DeveloperGuide.adoc
Outdated
|
||
The following sequence diagram shows how the add operation works: | ||
|
||
image::AddTaskSequenceDiagram.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.
Inconsistent that the style of the diagram changed.
docs/DeveloperGuide.adoc
Outdated
The following activity diagram summarizes what happens when a user executes a new command: | ||
The Exercise class is represented by the following class diagram below. | ||
|
||
image::ExerciseClassDiagram.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.
Should choose to show association using attribute or with arrow, but not both.
There are also too many details in this diagram. Private attributions don't have to be shown. 🙈
Wrote tests and fixed corresponding bugs
Create ViewMealPlan functionality
* 'master' of https://github.com/AY1920S1-CS2103T-T10-2/main: Write tests for MealPlan Write tests to improve coverage Fix EOF issue Fix UI for ViewMealPlan Add viewing of MealPlan Add EditPageCommand and corresponding tests Add styling to flowpane in DiaryCard Add more diary test cases Fix checkstyleTest Fix test cases Amend checkstyle Ammend result display for Recipe commands Make MealPlan creation and addition require existing Recipe Add more sample data to diary Add minor UI changes Add basic intro to PPP Write some StorageManager tests # Conflicts: # src/test/java/dukecooks/logic/commands/CommandTestUtil.java
Add more test cases and checks to health records
… into update-ppp3
Update dev guide
� Conflicts: � src/test/java/dukecooks/storage/StorageManagerTest.java
Adding test cases
� Conflicts: � src/main/java/dukecooks/logic/parser/ViewCommandParser.java � src/main/java/dukecooks/ui/MainWindow.java
Set to full screen window and fix sample data loading error
Add view workout functionality
Update About Us
Final updates to UG and DG
Update figure number
Update figure numbers in UG
Update PPP
Add sample data
Adds new data to Sample Data
Rename ppp
@hua-lun
@bakwxh
@khairulazman1997
@yyuanxin