Skip to content

Commit 6ea9f30

Browse files
authored
Merge pull request #80 from demitycho/1.3-UGDG
Update UG for AddLesson and DeleteLesson command
2 parents 5db8923 + ce592d6 commit 6ea9f30

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

docs/UserGuide.adoc

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -327,23 +327,49 @@ Selects the 1st student in the results of the `find` command.
327327
Shows your weekly schedule as a list of lessons. +
328328
Format: `schedule`
329329

330+
[NOTE]
331+
Currently displayed in the terminal. UI will be added in coming weeks.
332+
330333
=== Adding a lesson to your schedule: `addLesson`
331334

332335
Adds a lesson to your schedule for a student identified by the index number in the last student listing. +
333336
Format: `addLesson INDEX [d/DAY] [st/START_TIME] [et/END_TIME]`
334337

335338
****
336339
* 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.
338341
* 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`
340343
* Input lesson cannot clash with existing lessons already in the schedule.
341344
****
342345

343346
Examples:
344347

348+
* `list`
345349
* `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, ...
366+
****
367+
368+
Examples:
369+
370+
* `schedule`
371+
* `deleteLesson 2` +
372+
Deletes the 2nd lesson listing in the schedule
347373

348374
=== Listing entered commands : `history`
349375

0 commit comments

Comments
 (0)