Skip to content

Commit

Permalink
Merge pull request #247 from acekhoon/Bugs-UG
Browse files Browse the repository at this point in the history
Fix UG bugs found
  • Loading branch information
0liverkong authored Apr 14, 2024
2 parents 070e00a + 03d65ed commit fbf331e
Showing 1 changed file with 23 additions and 15 deletions.
38 changes: 23 additions & 15 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,14 +183,14 @@ Format: `edit INDEX [n/NAME] [e/EMAIL] [c/COUNTRY] [p/PHONE] [t/TAG]…​`

---
Examples:
* `edit 24 n/Johnny Doe e/johnnydoe@gmail.com c/SG`
* `edit 2 n/Johnny Doe e/johnnydoe@gmail.com c/SG`

This command edits **name**, **email**, and **country of residence** of the candidate with index 24 to **Johnny Doe**, **johnnydoe@gmail.com**, and **Singapore**, respectively.
This command edits **name**, **email**, and **country of residence** of the candidate with index 2 to **Johnny Doe**, **johnnydoe@gmail.com**, and **Singapore**, respectively.


* `edit 8 n/Jeb Song e/jebsong@gmail.com t/IMOGold`
* `edit 3 n/Jeb Song e/jebsong@gmail.com t/IMOGold`

This command edits **name**, **email**, and the tag for **acceptance status** of the candidate with index 8 to **Jeb Song**, **jebsong@gmail.com**, and **IMOGold**, respectively. Note that the existing tag(s) on this candidate (if any) is/are completely removed and a new tag `IMOGold` is added.
This command edits **name**, **email**, and the tag for **acceptance status** of the candidate with index 3 to **Jeb Song**, **jebsong@gmail.com**, and **IMOGold**, respectively. Note that the existing tag(s) on this candidate (if any) is/are completely removed and a new tag `IMOGold` is added.

---

Expand Down Expand Up @@ -218,7 +218,7 @@ Example:

Leaves comments on important points to note down for individual candidates during the recruitment process. This overwrites existing comment (if any) and displays the resulting candidate.

* `INDEX` must be within the range `1` to `n`, where `n` is the number of records in the database.
* `INDEX` must be within the range `1` to `n`, where `n` is the number of candidates in the displayed candidate list.

Format: `comment INDEX COMMENT`

Expand All @@ -239,22 +239,24 @@ Format: `tag INDEX t/TAG [t/TAG]…​`
* At least one tag must be provided.

Examples:
* `tag 24 t/smart` adds the tag "smart" to the candidate with index 24.
* `tag 8 t/ExceptionalWork t/IMOGold t/PhD` adds the tags "ExceptionalWork", "IMOGold" and "PhD" to the candidate with index 8.
* `tag 2 t/smart` adds the tag "smart" to the candidate with index 2.
* `tag 4 t/ExceptionalWork t/IMOGold t/PhD` adds the tags "ExceptionalWork", "IMOGold" and "PhD" to the candidate with index 4.

If tag command is successfully executed, the app will display the candidate with the new tags.

### Delete tag of a candidate: `delete_tag`

Deletes existing tag(s) from a candidate's list of tags

You can delete tags for any candidates 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 candidate list displayed in the UI.

Format: `delete_tag INDEX t/TAG [t/TAG]…​`

* At least one tag must be provided.
* The specified tag(s) must be in the candidate's list of tags.

Example:
* `delete_tag 1 t/ExceptionalWork t/IMOGold` removes these tags from the 1st candidate displayed.
* `delete_tag 2 t/colleagues t/friends` removes these tags from the 1st candidate displayed.

### Change status of an application: `status`

Expand All @@ -263,13 +265,15 @@ Changes the interview status of an application.
Interview status must be one of the following: `PRESCREEN`, `IN_PROGRESS`, `WAITLIST`, `OFFERED`, `REJECTED`.
When an application is added, by default it has status `PRESCREEN`.

You can edit status of any applications in the displayed list at the specified **INDEX**. Here, **INDEX** refers to the index number of applications shown in the displayed application list. The application index **must be** within the range from ***1*** to ***n***, where ***n*** represents the **number of applications** in the application list displayed in the UI.

Format: `status INDEX STATUS`

* The status update to an application of a job will fail under this condition:
* The status of the application to change to is `OFFERED`, and the number of `OFFERED` applications to the job is already equal to the number of vacancies of the job.

Example:
* `status 24 IN_PROGRESS` changes the status of the application with index 24 to `IN_PROGRESS`.
* `status 2 IN_PROGRESS` changes the status of the application with index 2 to `IN_PROGRESS`.

If status command is successfully executed, the app will display the application with the new status.

Expand All @@ -283,7 +287,7 @@ The above example attempts to add more `OFFERED` candidates for the job titled `

Deletes an existing candidate from the candidate list.

You can delete any candidates 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.
You can delete any candidates 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 candidate list displayed in the UI.

Format: `delete INDEX`

Expand All @@ -310,7 +314,9 @@ After the person has been successfully added, a success message will be shown in

### Delete a job: `delete_job`

Deletes an existing job from the job list.
Deletes an existing job from the job list displayed in the UI.

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

Format: `delete_job INDEX`

Expand All @@ -326,7 +332,9 @@ Example:

### Delete an application: `delete_app`

Deletes an existing application from the application list.
Deletes an existing application from the application list displayed in the UI.

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

Format: `delete_app INDEX`

Expand All @@ -341,7 +349,7 @@ Example:

### Clearing all entries : `clear`

Clears all entries from Hirehub's address book. All applications will be cleared as well.
Clears all entries from Hirehub's candidate list. All applications will be cleared as well.

* A confirmation message would be displayed. Type in **Y** to confirm the deletion.

Expand Down Expand Up @@ -401,7 +409,7 @@ Examples:

### Accessing by index: `get`

Accesses candidates by **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.
Accesses candidates by **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the candidate list. The candidate index **must be** within the range from 1 to n, where n represents the **number of candidates** in the candidate list displayed.

Format: `get INDEX`

Expand Down Expand Up @@ -460,7 +468,7 @@ HireHub data are saved in the hard disk automatically after any command that cha

### Editing the data files

HireHub data are saved automatically as JSON files `[JAR file location]/data/hirehub.json`, `[JAR file location]/data/jobs.json` and `[JAR file location]/data/applications.json`. Advanced users are welcome to update data directly by editing those data files.
HireHub data are saved automatically as JSON files `[JAR file location]/data/addressbook.json`, `[JAR file location]/data/jobs.json` and `[JAR file location]/data/applications.json`. Advanced users are welcome to update data directly by editing those data files.

<div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
If your changes to the data files makes their format invalid, HireHub will discard all data and start with empty data files at the next run. Hence, it is recommended to take a backup of the files before editing them.<br>
Expand Down

0 comments on commit fbf331e

Please sign in to comment.