From 7bbc5534f35ae8104418fd7aabc59c797de2703f Mon Sep 17 00:00:00 2001 From: iynixil Date: Fri, 12 Apr 2024 01:40:00 +0800 Subject: [PATCH] Add warnings to commands that result in data loss --- docs/UserGuide.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 19bb524cde0..4273872b023 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -255,7 +255,11 @@ Examples: ### Deleting a meeting from a person: `meeting-delete` -Deletes a meeting from person based on specified meeting index. +
: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. +
+ +Deletes a meeting from a person based on specified meeting index. Format: `meeting-delete INDEX i/MEETING-INDEX ` @@ -282,6 +286,10 @@ The following command was applied: `find Bernice Yu` followed by `meeting-delet ### Deleting a person : `delete` +
: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. +
+ Deletes the specified person from the contacts. Format: `delete INDEX` @@ -324,6 +332,11 @@ Examples: ### Refresh and clear all outdated meetings: `refresh` +
: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. +
+ Deletes all meetings that start before the very moment the user types in the command and enters. Format: `refresh` @@ -356,7 +369,11 @@ Examples: ### Clearing all entries : `clear` -Clears all entries from the contacts. +
: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. +
+ +Clears all entries from the staff book. Format: `clear`