You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/DeveloperGuide.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -246,18 +246,18 @@ In designing this feature, we had to consider several alternative ways in which
246
246
247
247
### Add Schedule feature
248
248
249
-
The add schedule feature allows user to create a schedule associated with a client and a session.
250
-
In other words, it allows user to schedule a client to a session.
249
+
The Add Achedule feature allows user to create a Schedule associated with a Client and a Session.
250
+
In other words, it allows user to schedule a Client to a Session.
251
251
252
252
#### Implementation
253
253
254
-
The add schedule mechanism is facilitated by `AddScheduleCommand` which extends `Command`. The format of the
254
+
The Add Schedule mechanism is facilitated by `AddScheduleCommand` which extends `Command`. The format of the
255
255
command is given by:
256
256
257
257
```schadd c/CLIENT_INDEX s/SESSION_INDEX```
258
-
When using this command, the `CLIENT_INDEX` should refer to the index shown in the Client List on the left panel, and is used to specify the client. The `SESSION_INDEX` should refer to the index shown in the Session List on the right panel, and is used to specify the session.
258
+
When using this command, the `CLIENT_INDEX` should refer to the index shown in the Client List on the left panel, and is used to specify the Client. The `SESSION_INDEX` should refer to the index shown in the Session List on the right panel, and is used to specify the Session.
259
259
260
-
The following activity diagram summarizes the decision making process when a user executes a new `AddSchedule` command. Notice how it checks for overlapping schedule first.
260
+
The following activity diagram summarizes the decision making process when a user executes a new `AddSchedule` command. Notice how it checks for overlapping Schedule first.
Now, consider two cases of add schedule command to be invoked.
270
+
Now, consider two cases of Add Schedule command to be invoked.
271
271
272
272
**Case 1**: `schadd c/2 s/1`
273
273
274
-
Invoking `schadd c/2 s/1` will add a schedule associated with Andy (the second client in the Client List) and endurance training from 12/12/2020 1400 - 1600 (the first session in the Session List).
274
+
Invoking `schadd c/2 s/1` will add a Schedule associated with Andy (the second Client in the Client List) and endurance training from 12/12/2020 1400 - 1600 (the first Session in the Session List).
275
275
276
-
Thus, the result can be illustrated by the following object diagram, shown by a new created schedule:
276
+
Thus, the result can be illustrated by the following object diagram, shown by a new created Schedule:
On the other hand, invoking `schadd c/1 s/1` will result in an error shown to the user as there is an overlapping schedule (John is already scheduled to endurance training from 12/12/2020 1400 - 1600).
282
+
On the other hand, invoking `schadd c/1 s/1` will result in an error shown to the user as there is an overlapping Schedule (John is already scheduled to endurance training from 12/12/2020 1400 - 1600).
Copy file name to clipboardExpand all lines: docs/UserGuide.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -481,7 +481,7 @@ of session view using [<code>sview</code>](#334-viewing-sessions-within-period--
481
481
482
482
### 3.3.1 Adding a Session : `sadd`
483
483
484
-
You can create a session with its relevant details. It will show up on the Session List panel on the right side of the UI.
484
+
You can create a session with its relevant details. If the new session is within the [viewing period](#334-viewing-sessions-within-period-sview) of the Session List, it will be displayed on the right panel of the UI.
485
485
This provides you with an easy reference to the periods in which you have session(s) scheduled and the location of each session.
@@ -490,7 +490,7 @@ Points to take note when adding a session to the Session List:
490
490
* Start time should be of format "dd/MM/yyyy HHmm" (date/month/year Hour minutes in 24 hr format).
491
491
* Duration is in minutes.
492
492
* Duration should be a positive integer (larger than 0).
493
-
* If you want to schedule a session with a client, you need to make sure the session exists in FitEgo, then create a schedule (`schadd`) that references the client and the session.
493
+
* If you want to schedule a session with a client, you need to make sure the session exists in FitEgo, then [create a schedule (`schadd`)](#341-adding-a-schedule-schadd) that references the client and the session.
494
494
495
495
<divmarkdown="block"class="alert alert-info">
496
496
@@ -511,7 +511,6 @@ This helps to prevent you from accidentally agreeing to 2 sessions that overlaps
511
511
512
512
Examples:
513
513
*`sadd g/New Gym ex/Endurance at/06/11/2020 0900 t/65` adds a session at gym `New Gym` with exercise type `Endurance` at `06/11/2020 0900hrs` that lasts for `65` minutes.
514
-
If the session is within the [viewing period](#334-viewing-sessions-within-period-sview) of the Session List, it will be displayed on the right panel of the UI.
0 commit comments