From d7057440ba3a2fb56269270ed2d20bc61fb0f27b Mon Sep 17 00:00:00 2001 From: Lalelulilulela Date: Mon, 15 Apr 2024 23:04:37 +0800 Subject: [PATCH] Update resume command --- docs/UserGuide.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index cb7d4da74f2..701de898ad3 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -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. @@ -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. @@ -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]`
e.g., `sort pri/`
e.g., `sort rev/ tt/` | -| **Resume** | `resume cn/COMPANY_NAME n/NAME p/PHONE e/EMAIL edu/EDUCATION s/SALARY [pl/SKILLS]`
e.g., `resume cn/Google n/John Doe p/98765432 e/johnd@example.com 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]...`
e.g., `resume cn/Google n/John Doe p/98765432 e/johnd@example.com s/3000 edu/NUS a/311, Clementi Ave 2, #02-25 pl/Java pl/C++ ` | ## CLI Syntax Summary @@ -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.


| -| `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.


| +| `PRIORITY` | Should be a number between 0 and 4. | | `INTERVIEW_TIME` | Should be in the format `ddMMyyyyHHmm`.
* `dd` - refers to the day and the acceptable range is from **01** to **31**
* `MM` - refers to the month and the acceptable range is from **01** to **12**
* `yyyy` - refers to the year and accepts any **4-digit** numbers from **0001** to **9999**
* `HH` - refers to the hour and the acceptable range is from **00** to **23**
* `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, …
_Note: CCBot does not consider 0 to be a positive integer_ | _Navigate back to [Table Of Contents](#table-of-contents)_