[CS2113-W13-2] FitnessDuke #53

EangJS · 2023-03-03T08:00:04Z

FitnessDuke is a CLI based workout tracker and guider, that helps individuals get them started on proper workout routines on a fixed schedule in the hopes of getting them fit and healthier.

…fix-edit-index Merge from fix-edit-index to master

Ng-YZ

Easy to read Developer Guide in general, could include slightly more details in some sections though!

Ng-YZ · 2023-03-29T04:13:32Z

docs/DeveloperGuide.md

+<div align="center">
+<img src="UML/Images/CommandHandler.png"/>
+<p>
+Figure 1.5
+</p>
+</div>


Perhaps can consider using reference frame over ExerciseSessionCommandHandler/GeneralCommandHandler then would also be nice to have separate sequence diagram in the next section(s) to show details.

Ng-YZ · 2023-03-29T04:16:32Z

docs/DeveloperGuide.md

+<div align="center">
+<img src="UML/Images/CommandHandler.png"/>
+<p>
+Figure 1.6
+</p>
+</div>


Is this figure meant to be the same as the one above? Would be nice if its a diagram showing how ExerciseSessionCommandHandler relates to the ExerciseStateHandler

Ng-YZ · 2023-03-29T04:23:05Z

docs/DeveloperGuide.md

+<img src="UML/Images/ErrorMessagesEnum.png"/>
+<div align="center">
+<p>
+Figure 1.7
+</p>
+</div>


Could consider including the enumeration values for ErrorMessages

Ng-YZ · 2023-03-29T04:28:39Z

docs/DeveloperGuide.md

+| V2.0    | - User                                                                                                   | - be able to start a workout and set it as complete and save it                                                                 | - reflect and track my progress                                                |
+| V2.0    | - User looking for motivation                                                                            | - be able to track my workout history as statistics                                                                             | - better visualise my overall progress                                         |
+| V2.0    | - user with little to no experience with exercise                                                        | - be given instructions for the specific exercise that I am working on                                                          | be educated on how to complete the exercise correctly                          |
+| V2.0    | - User who wants to stay motivated to workout </br> - User who wants to feel good about my past workouts | - See myself be able to accomplish or achieve incrementally greater goals </br> - Keep track of all my exercises                | - Continue to stay motivated in making exercise a fun, long-lasting habit      |


Seems like some slight formatting issue here

Yup, thats a known issue.Will correct them in the future iteration(s) 👍

Ng-YZ · 2023-03-29T04:35:24Z

docs/DeveloperGuide.md

+<img src="UML/Images/ErrorMessagesEnum.png"/>
+<div align="center">
+<p>
+Figure 1.7
+</p>
+</div>


Not very sure what this diagram is trying to show, composition seems a bit weird?

chinhan99

Overall good attempt on your diagrams. Do note the syntax errors as discussed ! Thanks!

chinhan99 · 2023-03-29T06:05:01Z

docs/UML/Images/Ui.png

Incorrect syntax such as "C" logo and the circle symbols. Do stick to cs2113 syntax

Check the arrows as discussed

chinhan99 · 2023-03-29T06:05:45Z

docs/UML/Images/overall_sequence-0.png

Do add the termination "cross" if necessary

chinhan99 · 2023-03-29T06:10:54Z

docs/UML/Images/CommandHandler.png

Check on the activation bars. and remove the class boxes at the bottom

chinhan99 · 2023-03-29T06:13:10Z

docs/UML/Images/ErrorMessagesEnum.png

Maybe can add more description to explain the way the classes interact with each other.

MingEn82 · 2023-03-29T07:18:02Z

docs/DeveloperGuide.md

+The class diagram as shown in Figure *1.3* illustrates the structure of the different classes in Ui.
+
+<div align="center">
+<img src="UML/Images/Ui.png"/>


For the class diagram, do consider removing the "C" logo in front of the class name and change the visibility to +/-/# instead as it is not the intended styling of in this module

MingEn82 · 2023-03-29T07:25:13Z

docs/DeveloperGuide.md

+#### Error Message Handling
+Enumeration: [```ErrorMessages.java```]
+All error messages are stored in the ErrorMessage enumeration for easy access across different classes that could run into similar exceptions.
+<img src="UML/Images/ErrorMessagesEnum.png"/>


Do consider changing the dotted solid arrow as I'm not sure we have learnt it in this module, hence readers may be confused by what it means

MingEn82 · 2023-03-29T09:07:44Z

docs/DeveloperGuide.md

+
+1. Information messages that describe the functionalities of the program (`Greet` , `Bye`, `PrintExercises` classes)
+2. Help messages that details the usage of the possible commands available in the program (`PrintHelpMessage` class)
+3. Error messages that trigger when a user's input is incorrect and provides an explanation to the


Maybe can give some examples of how the error messages are triggered

MingEn82 · 2023-03-29T09:09:39Z

docs/DeveloperGuide.md

+* Handles when there is no exercise ongoing, granting access to generating new exercises with different confines.
+
+<div align="center">
+<img src="UML/Images/CommandHandler.png"/>


Can consider removing the class boxes at the bottom

avielcx · 2023-03-30T04:12:57Z

docs/DeveloperGuide.md

+<div align="center">
+<img src="UML/Images/overall_sequence-0.png"/>
+<p>
+Figure 1.2


It will be good to show the end of class usage using the cross

avielcx · 2023-03-30T04:14:22Z

docs/DeveloperGuide.md

+<div align="center">
+<img src="UML/Images/overall_sequence-0.png"/>
+<p>
+Figure 1.2


It will be good to be consistent with the color coding of the classes. commandHandler and Storage has the same colour

avielcx · 2023-03-30T04:15:26Z

docs/DeveloperGuide.md

+
+1. Information messages that describe the functionalities of the program (`Greet` , `Bye`, `PrintExercises` classes)
+2. Help messages that details the usage of the possible commands available in the program (`PrintHelpMessage` class)
+3. Error messages that trigger when a user's input is incorrect and provides an explanation to the


It will be good to show examples of errors

avielcx · 2023-03-30T04:16:36Z

docs/DeveloperGuide.md

+| V2.0    | - User                                                                                                   | - be able to start a workout and set it as complete and save it                                                                 | - reflect and track my progress                                                |
+| V2.0    | - User looking for motivation                                                                            | - be able to track my workout history as statistics                                                                             | - better visualise my overall progress                                         |
+| V2.0    | - user with little to no experience with exercise                                                        | - be given instructions for the specific exercise that I am working on                                                          | be educated on how to complete the exercise correctly                          |
+| V2.0    | - User who wants to stay motivated to workout </br> - User who wants to feel good about my past workouts | - See myself be able to accomplish or achieve incrementally greater goals </br> - Keep track of all my exercises                | - Continue to stay motivated in making exercise a fun, long-lasting habit      |


There is a formatting issue here

avielcx · 2023-03-30T04:16:54Z

docs/DeveloperGuide.md

+Test cases:  ```o``` , ```hi```
+Expected: Error details will be shown in the terminal
+### ```find``` command
+1. Find a set of exercises based on a specified keyword : ```find [keyword]```


It will be good to show an example to the users

avielcx · 2023-03-30T04:24:10Z

docs/DeveloperGuide.md

+<div align="center">
+<img src="UML/Images/Storage.png"/>
+<p>
+Figure 1.4


There can be more comprehensive explanation to the diagram given the diagram's complexity

avielcx · 2023-03-30T04:24:20Z

docs/DeveloperGuide.md

+<div align="center">
+<img src="UML/Images/Ui.png"/>
+<p>
+Figure 1.3


There can be more comprehensive explanation to the diagram given the diagram's complexity

avielcx · 2023-03-30T04:26:53Z

docs/DeveloperGuide.md

+<div align="center">
+<img src="UML/Images/architecture.png"/>
+<p>
+Figure 1.1


Overall comments on the diagrams are that there can be more consistency in the colors across the different diagrams. Some of the diagrams have colours and some don't. It does not seem like it is coded by one person. Also, given that users read the DG for the first time, diagrams, even seemingly simple diagrams can be complicated. It will be good to have more explanations

avielcx · 2023-03-30T04:30:58Z

docs/DeveloperGuide.md

+Expected: Error details will be shown in the terminal
+### ```find``` command
+1. Find a set of exercises based on a specified keyword : ```find [keyword]```
+2.  Test case: ```find```


It will be good to add additional invalid entries of your commands

avielcx · 2023-03-30T04:31:55Z

docs/DeveloperGuide.md

-
-{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
+---
+title: Developer Guide


I like that the DG is very organized and the Dg is filled with diagram that is adequately understandable. Keep up the good work.

Magmanat

Overall Neat Developer Documentation, however could have better clarity on some of the diagrams

Magmanat · 2023-03-30T05:42:04Z

docs/DeveloperGuide.md

+<div align="center">
+<img src="UML/Images/architecture.png"/>
+<p>
+Figure 1.1
+</p>
+</div>


Not too sure why there are dotted arrows and solid arrows in the diagram, could be clearer in explaining the difference as developers might not understand the meaning behind them

Magmanat · 2023-03-30T05:42:26Z

docs/DeveloperGuide.md

+<div align="center">
+<img src="UML/Images/overall_sequence-0.png"/>
+<p>
+Figure 1.2
+</p>
+</div>


This is a nice diagram which is segregated by colors to represent the classes for easy reference, however this is not consistent with the rest of the developers docs, consider updating the rest of the dev docs to follow this format

Magmanat · 2023-03-30T05:42:56Z

docs/DeveloperGuide.md

+The class diagram as shown in *Figure 1.4* illustrates the structure of the different classes in Storage.
+<div align="center">
+<img src="UML/Images/Storage.png"/>
+<p>
+Figure 1.4
+</p>
+</div>


Diagram looks neat, however Storage Inherits from two different interfaces, is this possible in Java?

Storage interface extends UserPlansStorsge and UserCareerStorage interfaces. This is similar to AB3.

Magmanat · 2023-03-30T05:43:25Z

docs/DeveloperGuide.md

+The class diagram as shown in *Figure 1.4* illustrates the structure of the different classes in Storage.
+<div align="center">
+<img src="UML/Images/Storage.png"/>
+<p>
+Figure 1.4
+</p>
+</div>


The StorageManager has an association with UserPlansStorage and UserCareerStorage, however this is might be already implied and not needed since StorageManager implements Storage which inherits from UserPlansStorage and UserCareerStorage.

The StorageManager has an association with UserPlansStorage and UserCareerStorage, however this is might be already implied and not needed since StorageManager implements Storage which inherits from UserPlansStorage and UserCareerStorage.

Magmanat · 2023-03-30T05:44:21Z

docs/DeveloperGuide.md

+#### Error Message Handling
+Enumeration: [```ErrorMessages.java```]
+All error messages are stored in the ErrorMessage enumeration for easy access across different classes that could run into similar exceptions.
+<img src="UML/Images/ErrorMessagesEnum.png"/>


The dotted line with the black diamond is not a valid uml arrow representation which we have learnt in the module, possibly you meant to use a hollow diamond instead to represent aggregation?

Magmanat · 2023-03-30T05:44:45Z

docs/DeveloperGuide.md

+To manage this exists the ```ExerciseStateHandler```, which allows for saving, starting
+ending, cancelling workouts.
+<div align="center">
+<img src="UML/Images/CommandHandler.png"/>
+<p>
+Figure 1.7
+</p>
+</div>


Possibly missing out on the activation bar for all the classes that are involved in this sequential diagram.

Branch update v2 error

minor update to UG

Add PPP and bug fixes

Finalise PPP

updated own ppp

Finalise PPP

Fix DG

Update default.html

Update UG and PPP

Branch update v2.1

kyrixn added a commit to kyrixn/tp that referenced this pull request Mar 16, 2023

Merge pull request nus-cs2113-AY2223S2#53 from AY2223S2-CS2113-F13-3/…

5c785c5

…fix-edit-index Merge from fix-edit-index to master

Ng-YZ reviewed Mar 29, 2023

View reviewed changes

chinhan99 reviewed Mar 29, 2023

View reviewed changes

MingEn82 reviewed Mar 29, 2023

View reviewed changes

avielcx reviewed Mar 30, 2023

View reviewed changes

This comment was marked as outdated.

Sign in to view

Magmanat reviewed Mar 30, 2023

View reviewed changes

L-K-Chng and others added 22 commits April 1, 2023 19:33

improved ui for history command

b3edb96

Fixed broken hyperlinks in UG

14f3cca

Updated UserGuide to flow better. Also fixed broken hyperlinks.

e3f1099

Fixed junit test error

d656bfe

fix runtest.bat

ea2e6fa

Merge pull request #174 from L-K-Chng/branch-updateV2Error

e08f200

Branch update v2 error

Merge branch 'master' into branch-updateV2Error

e3ca893

minor update to UG

1d892df

Add EangJS @author

58fc527

Merge pull request #175 from Khulon/master

189be75

minor update to UG

Update EangJS PPP

9fa2fa4

Fix null input

d4f59df

Merge branch 'master' of github.com:EangJS/tp

6fb8b3a

IPPT calc feature

0fbf24b

Merge pull request #176 from EangJS/master

1bf32a1

Add PPP and bug fixes

Test TOC

0c7c639

Edit Hashes

84714e0

Merge branch 'master' into branch-updateV2Error

2e586d1

Updated User help message

a3c7a52

IPPT calc feature fix

1c3a30e

Merge branch 'master' of https://github.com/AY2223S2-CS2113-W13-2/tp

4046fc3

Checkstyle issues fixed

a0ad6a7

EangJS and others added 30 commits April 10, 2023 20:37

Clean up PPP

1705248

Merge branch 'master' of github.com:EangJS/tp

a72c6d7

Clean up PPP

26ba9c2

edited PPP

b0663d1

Merge branch 'AY2223S2-CS2113-W13-2:master' into master

3a40046

add details for ppp

0838d00

Merge pull request #225 from EangJS/master

a20eb76

Finalise PPP

Merge pull request #226 from Khulon/master

d285d79

updated own ppp

Merge branch 'master' into branch-updateV2.1

55034d9

Merge pull request #227 from L-K-Chng/branch-updateV2.1

52962ce

Finalise PPP

Update PPP and DG

e000e23

Update UG and DG and PPP

f79a1d6

Edit UML diagrams

2e0d8a8

Merge pull request #228 from ChubbsBunns/master

257aeda

Fix UG

c4689ff

Fix DG

bb94337

Delete Achievement text

ec39c7b

Merge pull request #229 from ChubbsBunns/master

4581b20

Fix DG

Update Code theme

d55be8c

Update default.html

041c187

Merge pull request #230 from AY2223S2-CS2113-W13-2/Styling

2c1e1a8

Update default.html

Update UG and PPP

8ba84ee

Update UG

02f5be9

updated UG

f80026f

Merge branch 'master' into branch-updateV2.1

af9bc98

Update UG Cat exercise

9841105

Merge pull request #231 from ChubbsBunns/master

b918eb4

Update UG and PPP

minor changes

ce5fad8

Merge pull request #232 from L-K-Chng/branch-updateV2.1

5e7dcf2

Branch update v2.1

add [] to help message

fdb9a94

[CS2113-W13-2] FitnessDuke #53

Are you sure you want to change the base?

[CS2113-W13-2] FitnessDuke #53

Conversation

EangJS commented Mar 3, 2023

Ng-YZ left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chinhan99 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as outdated.

Magmanat left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment