Skip to content

Commit

Permalink
Merge pull request #143 from woon17/Branch_UG
Browse files Browse the repository at this point in the history
Updates UG: edits addappt command in UG
  • Loading branch information
woon17 authored Oct 31, 2019
2 parents 1075efe + da766d3 commit b3ae9ce
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window. Alterna


* `register -id 001A -name John Doe -phone 98765432 -email [email protected] -address John street, block 123, #01-01` : registers a patient named `John Doe`.
* `enqueue 001A` : enqueues patient with reference id `001A` into the queue.
* `enqueue 001A` : enqueues patient with reference id `001A` into the queue. The patient `001A` must be registered.
* *`exit`* : exits the app.

. Refer to <<Features>> for details of each command.
Expand Down Expand Up @@ -129,13 +129,13 @@ Format: `doctors [<DOCTOR_NAME>]`

Registers a new doctor. +
If the staff reference identifier is not specified, a unique identifier will be assigned by the system.
Format: `newdoctor -name <STAFF_NAME> [-id <STAFF_REFERENCE_ID>] [-phone <PHONE_NUM>] [-email <EMAIL>] [-address <ADDRESS>]-num `
Format: `newdoctor -name <STAFF_NAME> [-id <STAFF_REFERENCE_ID>] [-phone <PHONE_NUM>] [-email <EMAIL>] [-address <ADDRESS>]-num`

==== Updates a doctor's profile: `updatedoctor` ====

If user is in the doctors listing screen, updates any change for doctor’s profiles. +
Format: `updatedoctor <ENTRY_ID> [-name <STAFF_NAME>]
[-id <STAFF_REFERENCE_ID>] [-phone <PHONE_NUM>] [-email <EMAIL>] [-address <ADDRESS>]-num `
[-id <STAFF_REFERENCE_ID>] [-phone <PHONE_NUM>] [-email <EMAIL>] [-address <ADDRESS>]-num`

==== Marks the doctor as on-duty: `onduty` ====

Expand All @@ -151,7 +151,7 @@ Format: `offduty <ENTRY_ID>`

==== Adds an appointment: `addappt` ====

Adds a new appointment for a patient +
Adds a new appointment for a existing patient. Timing must be valid and not conflict with doctors' duty roster.

If no optional fields `[-rec REPEATEDLY]` and `[-num RECURSIVE_TIMES]` are present, only one event will be added. Otherwise repeated appointments will be added. +

Expand Down Expand Up @@ -288,9 +288,9 @@ Format: `redo`

* *On-Duty Doctors Management* +
** doctors: `doctors [<DOCTOR_NAME>]`
** newdoctor: `newdoctor -name <STAFF_NAME> [-id <STAFF_REFERENCE_ID>] [-phone <PHONE_NUM>] [-email <EMAIL>] [-address <ADDRESS>]-num `
** newdoctor: `newdoctor -name <STAFF_NAME> [-id <STAFF_REFERENCE_ID>] [-phone <PHONE_NUM>] [-email <EMAIL>] [-address <ADDRESS>]-num`
** updatedoctor: `updatedoctor <ENTRY_ID> [-name <STAFF_NAME>]
[-id <STAFF_REFERENCE_ID>] [-phone <PHONE_NUM>] [-email <EMAIL>] [-address <ADDRESS>]-num `
[-id <STAFF_REFERENCE_ID>] [-phone <PHONE_NUM>] [-email <EMAIL>] [-address <ADDRESS>]-num`
** resigndoctor: `resigndoctor <ENTRY_ID>`
** onduty: `onduty <ROOM_NUMBER>`
** offduty: `offduty <ENTRY_ID>`
Expand Down

0 comments on commit b3ae9ce

Please sign in to comment.