From 5ebf8d17bd52042f5e4f46985b53ef7caa73a2f2 Mon Sep 17 00:00:00 2001 From: ThitipatC <111348715+ThitipatC@users.noreply.github.com> Date: Tue, 12 Mar 2024 17:46:48 +0800 Subject: [PATCH 1/2] Update UserGuide --- docs/UserGuide.md | 55 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 39 insertions(+), 16 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index e552130aa37..82a74547f63 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -203,34 +203,57 @@ Expected output: - Successful assignment: `Deadline has been assigned to :` - Failed assignment (example): `Deadline needs to be in MMM D YYYY format.` -### Clearing all entries : `clear` -Clears all entries from the address book. +### Add task : `add task` -Format: `clear` +Add the specified task to a project. -### Exiting the program : `exit` +Format: `add task /to ` -Exits the program. +* The specified project name must exist in the project list. +* The task's name must be unique + Examples: +* `add task add deadline command /to CS2103T Duke Chatbot Project` -Format: `exit` +Expected output: +* Successful add command: ` has been added to ` +* Failed commands: + - invalid project name: `Project not found: Please make sure the project exists.` + - repeated task: `Task already exists in ` -### Saving the data +### Remove task : `delete task` -AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. +Deletes the specified task from a project. -### Editing the data file +Format: `delete task /in ` -AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. +* The specified project name must exist in the project list. +* The task name must exist + Examples: +* `delete task add deadline command /in CS2103T Duke Chatbot Project` -
:exclamation: **Caution:** -If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
-Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. -
+Expected output: +* Successful deletion: ` has been deleted from ` +* Failed commands: + - invalid project name: `Project not found: Please make sure the project exists.` + - invalid task name: `Task not found: Please make sure the task exists` + + +### Show Project : `show project` + +shows the project’s details -### Archiving data files `[coming in v2.0]` +Format: `show project ` + +* The specified project name must exist in the project list. + +Examples: +* `show project CS2103T Duke Chatbot Project` + +Expected output: +* Successful display: `The ui now shows the project’s information` +* Failed commands: `Project not found: Please make sure the project exists.` -_Details coming soon ..._ --- From 53885a8b1ca28f17b40f48ef6acf11b22ad5d508 Mon Sep 17 00:00:00 2001 From: ThitipatC <111348715+ThitipatC@users.noreply.github.com> Date: Tue, 12 Mar 2024 17:52:24 +0800 Subject: [PATCH 2/2] Update UserGuide.md --- docs/UserGuide.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 82a74547f63..15d6f7c9ccc 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -208,7 +208,7 @@ Expected output: Add the specified task to a project. -Format: `add task /to ` +Format: `add task /to ` * The specified project name must exist in the project list. * The task's name must be unique @@ -216,16 +216,16 @@ Format: `add task /to ` * `add task add deadline command /to CS2103T Duke Chatbot Project` Expected output: -* Successful add command: ` has been added to ` +* Successful add command: ` has been added to ` * Failed commands: - invalid project name: `Project not found: Please make sure the project exists.` - - repeated task: `Task already exists in ` + - repeated task: `Task already exists in ` ### Remove task : `delete task` Deletes the specified task from a project. -Format: `delete task /in ` +Format: `delete task /in ` * The specified project name must exist in the project list. * The task name must exist @@ -233,17 +233,17 @@ Format: `delete task /in ` * `delete task add deadline command /in CS2103T Duke Chatbot Project` Expected output: -* Successful deletion: ` has been deleted from ` +* Successful deletion: ` has been deleted from ` * Failed commands: - invalid project name: `Project not found: Please make sure the project exists.` - - invalid task name: `Task not found: Please make sure the task exists` + - invalid task name: `Task not found: Please make sure the task exists` ### Show Project : `show project` shows the project’s details -Format: `show project ` +Format: `show project ` * The specified project name must exist in the project list.