Skip to content

Commit

Permalink
Merge pull request #28 from ThitipatC/updateUG
Browse files Browse the repository at this point in the history
Update UserGuide
  • Loading branch information
modembcc authored Mar 12, 2024
2 parents 48b5ab9 + 53885a8 commit 4bd204c
Showing 1 changed file with 39 additions and 16 deletions.
55 changes: 39 additions & 16 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,34 +203,57 @@ Expected output:
- Successful assignment: `Deadline <DEADLINE> has been assigned to <PROJECT_NAME>:<TASK_NAME>`
- 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 <TASK_NAME> /to <PROJECT_NAME>`

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: `<TASK_NAME> has been added to <PROJECT_NAME>`
* Failed commands:
- invalid project name: `Project <PROJECT_NAME> not found: Please make sure the project exists.`
- repeated task: `Task <TASK_NAME> already exists in <PROJECT_NAME>`

### 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 <TASK_NAME> /in <PROJECT_NAME> `

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`

<div markdown="span" class="alert alert-warning">: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.<br>
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.
</div>
Expected output:
* Successful deletion: `<TASK_NAME> has been deleted from <PROJECT_NAME>`
* Failed commands:
- invalid project name: `Project <PROJECT_NAME> not found: Please make sure the project exists.`
- invalid task name: `Task <TASK_NAME> 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 <PROJECT_NAME>`

* 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 <PROJECT_NAME> not found: Please make sure the project exists.`

_Details coming soon ..._

---

Expand Down

0 comments on commit 4bd204c

Please sign in to comment.