Skip to content

Commit

Permalink
User guide text style fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
acekhoon committed Feb 28, 2024
1 parent e5845ed commit f9ff456
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,7 @@ Format: `list`

### Edit Candidate Details: `edit`

In this section, we will learn about how to edit an existing candidate in the database with command format and examples.

#### 1. How to use the `edit` command?
Edits an existing candidate in the database with command format and examples.

You can edit any of the valid candidate details including name, email, country and tags at the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list.

Expand All @@ -112,18 +110,19 @@ Here is a valid format of `edit` command:
> [!WARNING]
> **Comment** field for the candidates **cannot be edited** by `edit` as there is a dedicated method for editing comments separately.
#### 2. Example usages of`edit` commands
---

*Example 1* : `edit 24 n/Johnny Doe e/[[email protected]](mailto:[email protected]) c/Singapore`

This command edits **name**, **email**, and **country of residence** of the candidate with index 24 to **Johnny Doe**, [[email protected]](mailto:[email protected]), and **Singapore**, respectively.

---

*Example 2* : `edit 8 n/Jeb Song e/[[email protected]](mailto:[email protected]) t/Accepted`

This command edits **name**, **email**, and the tag for **acceptance status** of the candidate with index 8 to **Jeb Song**, [[email protected]](mailto:[email protected]), and **Accepted**, respectively. Note that existing tag on this candidate is completely removed and new tag `accepted` if added.

---

If edit candidate command is successfully executed, the app will display the edited candidate with the edited attributes.


Expand All @@ -147,9 +146,7 @@ Examples:

### Delete Candidate: `delete`

In this section, we will learn about how to delete existing candidates in the database with command format and examples.

#### 1. How to use the `delete` command?
Delete existing candidates in the database with command format and examples.

You can delete any of candidate in the displayed list at the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list. The candidate index **must be** within the range from **1 to *n***, where ***n*** represents the **number of candidates** in the database.

Expand All @@ -161,7 +158,7 @@ Here is a valid format of `delete` command:
> [!NOTE]
> If INDEX number provided is valid, a confirmation message would be displayed where the user would type **y/n** to confirm the deletion upon the successful execution of the command. If ***y*** is selected for the deletion, it will delete the candidate from the list and display the deleted candidate with attributes. If ***n*** is selected for the deletion, it will display that the delete operation is cancelled.
#### 2. Example usage of`delete` commands
---

*Example* : `delete 3`

Expand Down

0 comments on commit f9ff456

Please sign in to comment.