Skip to content

Commit

Permalink
Merge pull request #229 from iynixil/222-bug-fix
Browse files Browse the repository at this point in the history
Add warnings in UG to commands that remove data
  • Loading branch information
whitesnowx authored Apr 11, 2024
2 parents 4300660 + 7bbc553 commit 4bab970
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,11 @@ Examples:

### Deleting a meeting from a person: `meeting-delete`

Deletes a meeting from person based on specified meeting index.
<div markdown="block" class="alert alert-danger">:warning: **Caution:**
There will be no further prompt after entering the command to delete a meeting from a person. This action is irreversible and the meeting information to be deleted cannot be retrieved afterwards.
</div>

Deletes a meeting from a person based on specified meeting index.

Format: `meeting-delete INDEX i/MEETING-INDEX `

Expand All @@ -294,6 +298,10 @@ The following command was applied: `find Bernice Yu` followed by `meeting-delet

### Deleting a person : `delete`

<div markdown="block" class="alert alert-danger">:warning: **Caution:**
There will be no further prompt after entering the command to delete a person in the staff book. This action is irreversible and the person to be deleted cannot be retrieved afterwards.
</div>

Deletes the specified person from the contacts.

Format: `delete INDEX`
Expand Down Expand Up @@ -347,6 +355,11 @@ Examples:

### Refresh and clear all outdated meetings: `refresh`

<div markdown="block" class="alert alert-danger">:warning: **Caution:**
This may result in possible data loss. e.g. Meetings of a person may be deleted.
There will be no further prompt after entering the command to refresh meetings of all persons. This action is irreversible and the meeting information that may be deleted cannot be retrieved afterwards.
</div>

Deletes all meetings that start before the very moment the user types in the command and enters.

Format: `refresh`
Expand Down Expand Up @@ -385,7 +398,11 @@ Examples:

### Clearing all entries : `clear`

Clears all entries from the contacts.
<div markdown="block" class="alert alert-danger">:warning: **Caution:**
There will be no further prompt after entering the command to clear all persons from the staff book. This action is irreversible and the staff book cannot be retrieved afterwards.
</div>

Clears all entries from the staff book.

Format: `clear`

Expand Down

0 comments on commit 4bab970

Please sign in to comment.