Skip to content

Commit b5357c8

Browse files
Merge pull request nus-cs2103-AY2021S1#90 from khor-jingqian/2101-update-ug-dg
Add names to contributions for CS2101
2 parents 549d972 + 3fe72ba commit b5357c8

File tree

2 files changed

+22
-25
lines changed

2 files changed

+22
-25
lines changed

docs/DeveloperGuide.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md).
1515

1616
## **Design**
1717

18-
### Architecture
18+
### Architecture (Jing Qian)
1919

2020
<img src="images/ArchitectureDiagram.png" width="450" />
2121

@@ -57,7 +57,7 @@ The *Sequence Diagram* below shows how the components interact with each other f
5757

5858
The sections below give more details of each component.
5959

60-
### UI component
60+
### UI component (Jing Qian)
6161

6262
![Structure of the UI Component](images/UiClassDiagram.png)
6363

@@ -73,7 +73,7 @@ The `UI` component,
7373
* Executes user commands using the `Logic` component.
7474
* Listens for changes to `Model` data so that the UI can be updated with the modified data.
7575

76-
### Logic component
76+
### Logic component (Jing Qian)
7777

7878
![Structure of the Logic Component](images/LogicClassDiagram.png)
7979

@@ -86,14 +86,14 @@ The `UI` component,
8686
1. The result of the command execution is encapsulated as a `CommandResult` object which is passed back to the `Ui`.
8787
1. In addition, the `CommandResult` object can also instruct the `Ui` to perform certain actions, such as displaying help to the user.
8888

89-
Given below is the Sequence Diagram for interactions within the `Logic` component for the `execute("delete 1")` API call.
89+
Given below is the Sequence Diagram for interactions within the `Logic` component for the `execute("exercise_delete 1")` API call.
9090

9191
![Interactions Inside the Logic Component for the `delete 1` Command](images/DeleteSequenceDiagram.png)
9292

93-
<div markdown="span" class="alert alert-info">:information_source: **Note:** The lifeline for `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
93+
<div markdown="span" class="alert alert-info">:information_source: **Note:** The lifeline for `ExerciseDeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
9494
</div>
9595

96-
### Model component
96+
### Model component (Jing Qian)
9797

9898
![Structure of the Model Component](images/ModelClassDiagram.png)
9999

@@ -114,7 +114,7 @@ The `Model`,
114114
</div>
115115

116116

117-
### Storage component
117+
### Storage component (Jing Qian)
118118

119119
![Structure of the Storage Component](images/StorageClassDiagram.png)
120120

@@ -124,7 +124,7 @@ The `Storage` component,
124124
* can save `UserPref` objects in json format and read it back.
125125
* can save the fitNUS data in json format and read it back.
126126

127-
### Common classes
127+
### Common classes
128128

129129
Classes used by multiple components are in the `seedu.addressbook.commons` package.
130130

@@ -134,7 +134,7 @@ Classes used by multiple components are in the `seedu.addressbook.commons` packa
134134

135135
This section describes some noteworthy details on how certain features are implemented.
136136

137-
### Create routine
137+
### Create routine (Jing Qian)
138138

139139
The feature to create a routine in fitNUS is implemented using `RoutineCreateCommand` class, which inherits from
140140
`Command` class. The argument is supplied after parsing the user input by the `RoutineCreateCommandParser` class.
@@ -174,7 +174,7 @@ Given below is the sequence diagram showing how the routine creation command is
174174

175175
![Routine Create](./images/RoutineAddSequenceDiagram.png)
176176

177-
### Add Routine to Timetable
177+
### Add Routine to Timetable (Nicholas)
178178

179179
The `TimetableAddRoutineCommandParser` and `TimetableAddRoutineCommand` classes parse and execute the user input
180180
to add a routine to the timetable in fitNUS.
@@ -221,7 +221,7 @@ execute("timetable_add_routine r/Leg Workout d/Monday T/1600-1700") API call.
221221

222222
![TimetableAddRoutineSequenceDiagram](images/TimetableAddRoutineSequenceDiagram.png)
223223

224-
### Find exercises
224+
### Find exercises (Licheng)
225225

226226
The find exercises feature is implemented using `FindExercisesCommandParser`, as well as the following command:
227227
* `FindExercisesCommand`, to be executed when the user inputs the command into fitNUS.
@@ -268,7 +268,7 @@ API call.
268268

269269
![FindExercisesSequenceDiagram](images/FindExercisesSequenceDiagram.png)
270270

271-
### Delete lesson
271+
### Delete lesson (Iqbal)
272272

273273
The delete lesson feature is implemented using `LessonDeleteCommandParser`, as well as the following command:
274274
* `LessonDeleteCommand`, to be executed when the user inputs the command into fitNUS.
@@ -339,7 +339,7 @@ The GUI then lists the deleted lesson.
339339
around their classes.
340340

341341

342-
### User stories
342+
### User stories (Jing QIan)
343343

344344
Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
345345

@@ -352,7 +352,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
352352
| `* * *` | health-conscious individual | log my BMI | keep better track of my health.
353353

354354

355-
### Use cases
355+
### Use cases (Licheng)
356356

357357
(For all use cases below, the **System** is the `fitNUS` and the **Actor** is the `user`, unless specified otherwise)
358358

@@ -597,7 +597,7 @@ testers are expected to do more *exploratory* testing.
597597

598598
1. _{ more test cases …​ }_
599599

600-
### Deleting a Routine
600+
### Deleting a Routine (Jing Qian)
601601

602602
1. Deleting a Routine
603603

docs/UserGuide.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: User Guide
88
{:toc}
99

1010
------------------------------------------------------------------------------------------------------------------------
11-
## 1. Introduction
11+
## 1. Introduction (Licheng)
1212

1313
fitNUS is tailored for **NUS students** that are interested in staying healthy and keeping fit. It is suitable for **all
1414
fitness levels** and is equipped with a **customisable timetable** for you to manage your time wisely and slot in your
@@ -48,7 +48,7 @@ Note how the app contains some sample data.<br>
4848
--------------------------------------------------------------------------------------------------------------------
4949
## 3. Features
5050

51-
### 3.1 Exercise
51+
### 3.1 Exercise (Licheng)
5252

5353
#### 3.1.1 Create new exercise : `exercise_add`
5454

@@ -92,7 +92,7 @@ Example:
9292

9393
![Find Exercises](./images/find_exercises.png);
9494

95-
### 3.2 Routine
95+
### 3.2 Routine (Jing Qian)
9696

9797
#### 3.2.1 Create new routine : `routine_create`
9898

@@ -181,7 +181,7 @@ Example:
181181

182182
![Find Routines Result](./images/routine_find_after.png)
183183

184-
### 3.3 Lesson
184+
### 3.3 Lesson (Nicholas)
185185

186186
#### 3.3.1 Create new lesson : `lesson_add`
187187

@@ -269,9 +269,6 @@ Deletes the routine or lesson scheduled on Monday, 1600-1800.
269269

270270
![Timetable Delete](./images/timetable_delete.png)
271271

272-
### BMI
273-
274-
#### Add or edit height : `height`
275272

276273
#### 3.4.4 View timetable : `timetable_view`
277274

@@ -282,7 +279,7 @@ Format: `timetable_view`
282279
Examples:
283280
* `timetable view` Views timetable.
284281

285-
### 3.5 BMI
282+
### 3.5 BMI (Jing Qian)
286283

287284
#### 3.5.1 Add or edit height : `height`
288285

@@ -315,7 +312,7 @@ Format: `bmi`
315312
Examples:
316313
* `bmi` Views BMI.
317314

318-
### 3.6 Miscellaneous
315+
### 3.6 Miscellaneous (Jing Qian)
319316

320317
#### 3.6.1 Help: `help`
321318

@@ -343,7 +340,7 @@ _{explain the feature here}_
343340

344341
--------------------------------------------------------------------------------------------------------------------
345342

346-
## 4. Command summary
343+
## 4. Command summary (Nicholas)
347344

348345
### 4.1 Miscellaneous
349346

0 commit comments

Comments
 (0)