Skip to content

Commit

Permalink
Update resume command
Browse files Browse the repository at this point in the history
  • Loading branch information
Lalelulilulela committed Apr 15, 2024
1 parent 978d576 commit d705744
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,8 @@ i/Remote work s/4000 pl/Python t/criminal pri/4`

Adds a resume.

Format: `resume cn/COMPANY_NAME n/NAME p/PHONE_NUMBER a/ADDRESS e/EMAIL s/SALARY edu/EDUCATION [pl/PROGRAMMING-LANGUAGE]...`
Format: `resume cn/COMPANY_NAME n/NAME p/PHONE_NUMBER a/ADDRESS e/EMAIL s/SALARY edu/EDUCATION
[pl/PROGRAMMING_LANGUAGE]...`

* Refer to [parameter constraints table](#parameter-constraints) for more details on acceptable inputs.

Expand Down Expand Up @@ -273,7 +274,7 @@ Format: `filter s/SALARY_RANGE [SALARY_RANGE]...`
* `>=INTEGER`
* `<=INTEGER`

where `INTEGER` is a number inclusive of and within 0 and 2147483647.
where `INTEGER` is a number inclusive of and between 0 and 2147483647.

Examples:
* `filter s/5000` returns persons with salaries of $5000.
Expand Down Expand Up @@ -416,7 +417,7 @@ contains the data of your previous CCBot home folder.
| **List** | `list` |
| **Help** | `help` |
| **Sort** | `sort` or `sort rev/ [pri/PRIORITY] [n/NAME] [cn/COMPANY_NAME] [s/SALARY] [tt/INTERVIEW_TIME] [jd/JOB_DIFFICULTY]` <br> e.g., `sort pri/`<br> e.g., `sort rev/ tt/` |
| **Resume** | `resume cn/COMPANY_NAME n/NAME p/PHONE e/EMAIL edu/EDUCATION s/SALARY [pl/SKILLS]` <br> e.g., `resume cn/Google n/John Doe p/98765432 e/[email protected] s/3000 edu/NUS a/311, Clementi Ave 2, #02-25 pl/Java pl/C++ ` |
| **Resume** | `resume cn/COMPANY_NAME n/NAME p/PHONE e/EMAIL edu/EDUCATION s/SALARY [pl/PROGRAMMING_LANGUAGE]...` <br> e.g., `resume cn/Google n/John Doe p/98765432 e/[email protected] s/3000 edu/NUS a/311, Clementi Ave 2, #02-25 pl/Java pl/C++ ` |

## CLI Syntax Summary

Expand All @@ -436,20 +437,20 @@ contains the data of your previous CCBot home folder.

## Parameter Constraints

| Field | Constraint |
|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `COMPANY_NAME` | Should be less than 100 characters, and it should not be blank. |
| `NAME` | Should only contain alphanumeric characters and spaces, and it should not be blank. |
| `PHONE_NUMBER` | Should only contain numbers, and it should be at least 3 digits long. |
| `EMAIL` | Should be a valid email address. |
| `ADDRESS` | Can take any values, and it should not be blank. |
| `SALARY` | Should only contain numbers, with range [0, 2147483647] or two pure digital numbers with '-' in between. Both digital numbers should be within the range [0, 2147483647]. |
| `PROGRAMMING_LANGUAGE` | Should be alphanumeric and may contain some special characters (+ and #), and must be less than 50 characters. |
| `TAG` | Should be a single alphanumerical word that does not contain spaces. <br/><br/> <br/> |
| `PRIORITY` | Should be a number between 0 and 4. |
| Field | Constraint |
|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `COMPANY_NAME` | Should be less than 100 characters, and it should not be blank. |
| `NAME` | Should only contain alphanumeric characters and spaces, and it should not be blank. |
| `PHONE_NUMBER` | Should only contain numbers, and it should be at least 3 digits long. |
| `EMAIL` | Should be a valid email address. |
| `ADDRESS` | Can take any values, and it should not be blank. |
| `SALARY` | Should only contain numbers, with range [0, 2147483647] or two pure digital numbers with '-' in between. Both digital numbers should be within the range [0, 2147483647]. |
| `PROGRAMMING_LANGUAGE` | Should be alphanumeric and may contain some special characters (+ and #), and must be less than 50 characters. |
| `TAG` | Should be a single alphanumerical word that does not contain spaces. <br/><br/> <br/> |
| `PRIORITY` | Should be a number between 0 and 4. |
| `INTERVIEW_TIME` | Should be in the format `ddMMyyyyHHmm`.<br/>* `dd` - refers to the day and the acceptable range is from **01** to **31**<br/> * `MM` - refers to the month and the acceptable range is from **01** to **12**<br/>* `yyyy` - refers to the year and accepts any **4-digit** numbers from **0001** to **9999**<br/> * `HH` - refers to the hour and the acceptable range is from **00** to **23**<br/> * `mm` - refers to the minutes and the acceptable range is from **00** to **59** |
| `INFO` | Can take any values, and it should not be blank. |
| `EDUCATION` | Should only contain alphanumeric characters and spaces, and it should not be blank. |
| `INDEX` | The index **must be a positive integer** 1, 2, 3, … |
| `INFO` | Can take any values, and it should not be blank. |
| `EDUCATION` | Should only contain alphanumeric characters and spaces, and it should not be blank. |
| `INDEX` | The index **must be a positive integer** 1, 2, 3, …<br/> _Note: CCBot does not consider 0 to be a positive integer_ |

_Navigate back to [Table Of Contents](#table-of-contents)_

0 comments on commit d705744

Please sign in to comment.