Skip to content

Commit

Permalink
Revert "Add notes on how email and dates are parsed"
Browse files Browse the repository at this point in the history
  • Loading branch information
@rxchell
rxchell authored Nov 11, 2024
1 parent 2297435 commit 39071ef
Showing 1 changed file with 9 additions and 26 deletions.
35 changes: 9 additions & 26 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -320,17 +320,15 @@ A **person** is a patient with several fields. The fields and their correspondin
|------------------|--------|----------|----------|--------------------------------------------------------|
| **Name** | `n/` | No | No | Only alphanumeric characters (Cannot start with space) |
| **Phone number** | `p/` | No | No | Positive integer of length 3-15 (Inclusive) |
| **Email** | `e/` | No | No | Refer to 1. below |
| **Email** | `e/` | No | No | Refer to * |
| **Address** | `a/` | No | No | Any value |
| **Status** | `st/` | No | No | Only alphanumeric characters |
| **Tag(s)** | `t/` | Yes | Yes | Only alphanumeric characters |

You can identify these patients uniquely by their **patient ID (PID)** for easy reference.

---
**Notes**

1. Emails must have a local part containing alphanumeric characters and specific symbols (`+_.-`) (not at the start or end), followed by `@`, and a domain part with labels separated by periods, ending in a label with at least two alphanumeric characters, and no labels starting or ending with hyphens.
* Emails must have a local part containing alphanumeric characters and specific symbols (`+_.-`) (not at the start or end), followed by `@`, and a domain part with labels separated by periods, ending in a label with at least two alphanumeric characters, and no labels starting or ending with hyphens.

<br>

Expand Down Expand Up @@ -423,13 +421,6 @@ Edits an existing patient in DocTrack.

</box>

<box type="info" light>

**Note:** When editing the name of a person, the person's appointments will not reflect the name change until a reload
of the application.

</box>

<box style="background: #eeeeee">

**Navigate back to the subsections here:**
Expand Down Expand Up @@ -547,20 +538,16 @@ Note that this will also clear the appointment data.

An **appointment** is defined by several fields. The fields and their corresponding prefixes are as follows:

| Field | Prefix | Optional | Multiple | Acceptable Inputs |
|---------------------|--------|----------|----------|---------------------------------------|
| **Person ID** | `i/` | No | No | Existing person ID |
| **Appointment Type**| `ty/` | No | No | Any value |
| **Date and Time** | `d/` | No | No | `yyyy-MM-dd HH:mm`. Refer to 1. below |
| **Sickness** | `s/` | Yes | No | At least one alphabetic character |
| **Medicine** | `m/` | Yes | No | At least one alphabetic character |
| Field | Prefix | Optional | Multiple | Acceptable Inputs |
|---------------------|--------|----------|----------|-----------------------------------|
| **Person ID** | `i/` | No | No | Existing person ID |
| **Appointment Type**| `ty/` | No | No | Any value |
| **Date and Time** | `d/` | No | No | `yyyy-MM-dd HH:mm` |
| **Sickness** | `s/` | Yes | No | At least one alphabetic character |
| **Medicine** | `m/` | Yes | No | At least one alphabetic character |

You can manage the appointments through different commands, which can be seen in the table below:

**Notes:**

1. The date and time inputs are resolved "smartly" - meaning that certain incorrect dates will be allowed, e.g. `2025-02-29 12:00` will be parsed as `2024-02-28 12:00`.

<br>

| Action | Format | Examples |
Expand Down Expand Up @@ -647,8 +634,6 @@ You can an existing appointment in appointment book.

<br>

<br>

<box style="background: #eeeeee">

**Navigate back to the subsections here:**
Expand Down Expand Up @@ -965,5 +950,3 @@ folder, you can copy these files to another location as a backup.
3. On **MacOS systems**, the bold fonts may appear slightly clipped.

<br>

4. Editing the name in the `edit person` command will not reflect the name change in the appointments until a reload of the application.

0 comments on commit 39071ef

Please sign in to comment.