Merge pull request #310 from Praneet-25/branch-documents

Edits to PPP

docs/DeveloperGuide.md

@@ -31,11 +31,13 @@ effectively via the **Command Line Interface (CLI)**. Whether you want to manage
 intake, track your water consumption, set daily goals,
 or keep a record of your exercises, **ActiveEdge** has got
 you covered.
+
 ### Purpose
 This document specifies the architectural and software design decisions in the implementation of **ActiveEdge**.    
 For an in-depth understanding of how to use the application and explanations into each specific command, 
 feel free to visit our [Active Edge User Guide](UserGuide.md).
 
+
 ## Quick Start
 
 To get started quickly with ActiveEdge,
@@ -54,6 +56,7 @@ Take the next step in your Healthy Lifestyle!
 (e.g. typing ```help``` and pressing `Enter` will give you the list of available commands).
 
 ## Design & implementation 
+
 ### System Architecture
 
 ![System Architecture](https://github.com/SuveenE/tp/blob/master/images/System-Architecture.png?raw=true)
@@ -143,7 +146,6 @@ ensuring structured data handling within the program.
 
 ### User Details Package
 
-
 The `UserDetails` package is designed to capture and manage various user metrics 
 such as height, weight, and BMI within an application. This class is extended by three specific subclasses: `LogHeight`,
 `LogWeight`, and `LogBMI`, each storing respective metrics along with the date and 
@@ -157,7 +159,6 @@ entries from the list.
 ![Userdetails](https://github.com/AY2324S2-CS2113-W12-2/tp/blob/master/images/Userdetails.png?raw=true)
 
 
-
 ## Product scope
 ### Target user profile
 Our app targets NUS university students, including fitness enthusiasts and those striving for healthier lifestyles 
@@ -194,13 +195,12 @@ them achieve fitness goals while managing university life.
 | v2.0    |new user|log in my height and weight|see what range my weight is in|
 
 
-
-
 ## Non-Functional Requirements
 1. Should be portable and working on any mainstream OS as long as it has Java 11 or above installed.
 2. Should be able to hold up to 100 food items or list of exercises without any lag in the performance of the app  for typical usage.
 3. The average keyboard user should complete tasks more quickly using ActiveEdge compared to a standard GUI application.
 
+
 ## Glossary
 
 * *Log* - Entering your food, water and exercise data into the tracker.
@@ -209,6 +209,7 @@ them achieve fitness goals while managing university life.
 * *Summary* - Summarises the logged data of total water, calorie intake comparing it to the goals of the users.
 * *wg* - Water goal (`change wg` used to change water goal)
 * *cg* - Calorie goal (`change cg` used to change calorie goal)
+
 ## Instructions for manual testing
 
 1. Launching the App 
@@ -232,6 +233,7 @@ them achieve fitness goals while managing university life.
 
 7. Run the `bye` command to exit app.
 
+
 ## Command Summary
 
 | Action                                | Format                                                             |

docs/team/alvinnnnnnnnnn.md

@@ -31,7 +31,6 @@ from wherever they left off
 12. Created `GetHeightCommand` inside `command` package to allow the user to get their height 
 13. Created `GetWeightCommand` inside `command` package to allow the user to get their weight
 
-
 #### Contributions to User Guide
 1. Added on features to the `command summary` part
 
@@ -49,4 +48,3 @@ from wherever they left off
 1. Gave constructive feedbacks in PRs
 2. Effectively provided guidance and support to my team, giving my inputs whenever they face an issue
 
-

docs/team/praneet-25.md

@@ -12,16 +12,17 @@ to take a look at the code I contributed
 1. Implemented `ExerciseData` and `FoodData` class to store information about the food and exercises
 2. Implemented `ShowSummaryCommand` class to calculate the calorie status of user and the meal, water intake and exercises
 logged in the by user
-3. Wrote test codes for `exerciseDataTest`, `foodDataTest`  and `ChangeCalorieGoalCommandTest`
-4. Made changes to the `parser` to facilitate the logging of exercises and meals without any errors
+3. Implemented `ChangeCalorieGoalCommand` class to enable the user to change the calorie goal
+4. Wrote test codes for `exerciseDataTest`, `foodDataTest`  and `ChangeCalorieGoalCommandTest`
+5. Made changes to the `parser` to facilitate the logging of exercises and meals without any errors
 
 **Contributions to the UG:** I included the testing data for the food items and exercises. In addition, I made 
 contributions to the command summary list. I also added screenshots for some of the expected outputs of some features 
 such as logging water intake, logging exercises and etc.
 
 **Contributions to the DG:** I was in charge of crafting the sequence diagrams for the storage and parser package
-and amended the command summary. The diagrams provide insight the interactions within the system, ensuring the users
-can better understand the software development process. In addition, I wrote the instructions of how to use the 
+and amended the command summary. The diagrams provide insight of the interactions within the system, ensuring that the 
+users can better understand the software development process. In addition, I wrote the instructions of how to use the 
 developer guide and the non-functional requirements.
 
 **Contributions to team-based tasks:** We divided the workload equally, and I closely monitored progress to address any 
@@ -32,5 +33,5 @@ issues I discovered.
 effectively, providing detailed feedback on Pull Requests, and ensuring code quality through rigorous testing.
 
 **Contributions beyond the project team:** Beyond our project team, I actively engaged with the community by sharing
-insights and assisting on forums. I also contributed to other teams' projects by reporting bugs and offering help, 
-demonstrating my collaborative nature and dedication to supporting others.
+insights on forums. I also contributed to other teams' projects by reporting bugs and offering help, demonstrating my 
+collaborative nature and dedication to supporting others.