Skip to content

Commit 085c8ac

Browse files
Merge pull request #54 from demitycho/scheduling-docs
Updated User Guide Fixes #53
2 parents 3cf9b03 + 490ced3 commit 085c8ac

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/UserGuide.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,29 @@ Selects the 2nd student in the address book.
227227
`select 1` +
228228
Selects the 1st student in the results of the `find` command.
229229

230+
=== Viewing your schedule : `schedule`
231+
232+
Shows your weekly schedule as a list of lessons. +
233+
Format: `schedule`
234+
235+
=== Adding a lesson to your schedule: `addLesson`
236+
237+
Adds a lesson to your schedule for a student identified by the index number in the last student listing. +
238+
Format: `addLesson INDEX [d/DAY] [st/START_TIME] [et/END_TIME]`
239+
240+
****
241+
* 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, ...
242+
* 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.
243+
* The time input must be in the format `HH:MM`, seperated by a colon '`:`'
244+
* The time input must be a valid time within the range of `00:00` to `23:59`
245+
* Input lesson cannot clash with existing lessons already in the schedule.
246+
****
247+
248+
Examples:
249+
250+
* `addLesson 1 d/mon st/10:00 et/10:30` +
251+
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`.
252+
230253
=== Listing entered commands : `history`
231254

232255
Lists all the commands that you have entered in reverse chronological order. +

0 commit comments

Comments
 (0)