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/UserGuide.adoc
+29-3Lines changed: 29 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -327,23 +327,49 @@ Selects the 1st student in the results of the `find` command.
327
327
Shows your weekly schedule as a list of lessons. +
328
328
Format: `schedule`
329
329
330
+
[NOTE]
331
+
Currently displayed in the terminal. UI will be added in coming weeks.
332
+
330
333
=== Adding a lesson to your schedule: `addLesson`
331
334
332
335
Adds a lesson to your schedule for a student identified by the index number in the last student listing. +
333
336
Format: `addLesson INDEX [d/DAY] [st/START_TIME] [et/END_TIME]`
334
337
335
338
****
336
339
* Adds a lesson for the student at the specified `INDEX`. The index refers to the index number shown in the last student listing. The index *must be a positive integer* 1, 2, 3, ...
337
-
* The day for the input is the first three letters (non-case sensitive) of the name of day, i.e. `mon` for Monday, `fri` for Friday.
340
+
* The day for the input is the abbreviated first three letters (non-case sensitive) of the name of day, i.e. `mon` for Monday, `fri` for Friday.
338
341
* The time input must be in the format `HH:MM`, seperated by a colon '`:`'
339
-
* The time input must be a valid time within the range of `00:00` to `23:59`
342
+
* The time input must be a valid 24-hour time within the range of `00:00` to `23:59`
340
343
* Input lesson cannot clash with existing lessons already in the schedule.
341
344
****
342
345
343
346
Examples:
344
347
348
+
* `list`
345
349
* `addLesson 1 d/mon st/10:00 et/10:30` +
346
-
Adds a lesson for the 1st student. Lesson time will be on `mon` and starting time will be `10:00` and ending time will be `10:30`.
350
+
Adds a lesson for the 1st student of the `list` command. Lesson will be held on the day of `mon` and starting time will be `10:00` and ending time will be `10:30`.
351
+
352
+
353
+
* `find Betsy`
354
+
* `addLesson 1 d/tue st/12:00 et/13:30` +
355
+
Adds a lesson for the 1st student of the `find Betsy` command. Lesson will be held on the day of `tue` and starting time will be `12:00` and ending time will be `13:30`.
356
+
357
+
=== Deleting a lesson in your schedule: `deleteLesson`
358
+
359
+
Deletes an existing lesson in your schedule identified by the index number in the last schedule listing. of day, i.e. `mon` for Monday, `fri` for Friday.
360
+
361
+
Format: `deleteLesson INDEX`
362
+
363
+
****
364
+
* Deletes a lesson for the student at the specified `INDEX`.
365
+
* The index refers to the index number shown in the last schedule listing. The index *must be a positive integer* 1, 2, 3, ...
0 commit comments