Skip to content

Commit

Permalink
Update UG parameter separation
Browse files Browse the repository at this point in the history
  • Loading branch information
@wxwern
wxwern committed Nov 13, 2023
1 parent ed830b3 commit 8e4aa00
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -794,20 +794,20 @@ Exits the program.

| Parameter | Used by | Requirements | Examples |
|-----------|---------|--------------|----------|
| `INDEX` | [`edit`](#editing-contacts---edit) <br> [`apply`](#applying-to-organizations---apply) <br> [`edit --application`{:.language-sh}](#editing-job-applications---edit---application) <br> [`delete`](#deleting-contacts---delete) <br> [`delete --application`{:.language-sh}](#deleting-job-applications---delete---application) | A valid index can accept any positive integer up to the number of items displayed in the contact or job application list where applicable. | `1`<br>`10` |
| `NAME` | [`add --org`{:.language-sh}](#adding-organizations---add---org) <br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br> [`edit`](#editing-contacts---edit) | A valid name can accept any non-empty value. | `Ryan Koh`<br>`小明` |
| `ID` | [`add --org`{:.language-sh}](#adding-organizations---add---org) <br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br> [`edit`](#editing-contacts---edit) <br> [`apply`](#applying-to-organizations---apply) <br> [`delete`](#deleting-contacts---delete) | A valid ID has to start with a letter.<br><br>It can consist of alphanumeric and basic symbols (i.e. `a-z`, `A-Z`, `0-9`, `-`, `_`) | `woogle123`<br>`ryan_soc-rec` |
| `NUMBER` | [`add --org`{:.language-sh}](#adding-organizations---add---org) <br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br> [`edit`](#editing-contacts---edit) | A valid phone number can consist of only numbers with no whitespace.<br><br>It must be at least 3 digits. | `999`<br>`91824137` |
| `EMAIL` | [`add --org`{:.language-sh}](#adding-organizations---add---org) <br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br> [`edit`](#editing-contacts---edit) | A valid email should be in the form of `local-part@domain` where the `local-part` and `domain` must be separated by a single **@**.<br><br>The `local-part` can consist of any character except whitespace.<br><br>The `domain` name can comprise of one or more labels separated by periods, and each label can include any character except whitespace. The last `domain` label must be a minimum of two characters long. | `ryankoh@nus`<br>`[email protected]` |
| `URL` | [`add --org`{:.language-sh}](#adding-organizations---add---org) <br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br> [`edit`](#editing-contacts---edit) | A valid url should include a part in the form of `domain.tld` where the `domain` and the `tld` (top level domain) must be separated by a period. | `example.com`<br>`example.more.com`<br>`https://example.com`<br>`example.com/more` |
| `ADDRESS`| [`add --org`{:.language-sh}](#adding-organizations---add---org) <br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br> [`edit`](#editing-contacts---edit) | A valid address can accept any non-empty value.<br><br>For a contact, it designates its physical address. | `21 Lower Kent Ridge Rd` |
| `TAG` | [`add --org`{:.language-sh}](#adding-organizations---add---org) <br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br> [`edit`](#editing-contacts---edit) | A valid tag can consist of only alphanumeric characters. | `internship`<br>`network`<br>`parttime`<br>`jobPortal` |
| `INDEX` | [`edit`](#editing-contacts---edit) <br><br> [`apply`](#applying-to-organizations---apply) <br><br> [`edit --application`{:.language-sh}](#editing-job-applications---edit---application) <br><br> [`delete`](#deleting-contacts---delete) <br><br> [`delete --application`{:.language-sh}](#deleting-job-applications---delete---application) | A valid index can accept any positive integer up to the number of items displayed in the contact or job application list where applicable. | `1`<br>`10` |
| `NAME` | [`add --org`{:.language-sh}](#adding-organizations---add---org) <br><br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br><br> [`edit`](#editing-contacts---edit) | A valid name can accept any non-empty value. | `Ryan Koh`<br>`小明` |
| `ID` | [`add --org`{:.language-sh}](#adding-organizations---add---org) <br><br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br><br> [`edit`](#editing-contacts---edit) <br><br> [`apply`](#applying-to-organizations---apply) <br><br> [`delete`](#deleting-contacts---delete) | A valid ID has to start with a letter.<br><br>It can consist of alphanumeric and basic symbols (i.e. `a-z`, `A-Z`, `0-9`, `-`, `_`) | `woogle123`<br>`ryan_soc-rec` |
| `NUMBER` | [`add --org`{:.language-sh}](#adding-organizations---add---org) <br><br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br><br> [`edit`](#editing-contacts---edit) | A valid phone number can consist of only numbers with no whitespace.<br><br>It must be at least 3 digits. | `999`<br>`91824137` |
| `EMAIL` | [`add --org`{:.language-sh}](#adding-organizations---add---org) <br><br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br><br> [`edit`](#editing-contacts---edit) | A valid email should be in the form of `local-part@domain` where the `local-part` and `domain` must be separated by a single **@**.<br><br>The `local-part` can consist of any character except whitespace.<br><br>The `domain` name can comprise of one or more labels separated by periods, and each label can include any character except whitespace. The last `domain` label must be a minimum of two characters long. | `ryankoh@nus`<br>`[email protected]` |
| `URL` | [`add --org`{:.language-sh}](#adding-organizations---add---org) <br><br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br><br> [`edit`](#editing-contacts---edit) | A valid url should include a part in the form of `domain.tld` where the `domain` and the `tld` (top level domain) must be separated by a period. | `example.com`<br>`example.more.com`<br>`https://example.com`<br>`example.com/more` |
| `ADDRESS`| [`add --org`{:.language-sh}](#adding-organizations---add---org) <br><br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br><br> [`edit`](#editing-contacts---edit) | A valid address can accept any non-empty value.<br><br>For a contact, it designates its physical address. | `21 Lower Kent Ridge Rd` |
| `TAG` | [`add --org`{:.language-sh}](#adding-organizations---add---org) <br><br> [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) <br><br> [`edit`](#editing-contacts---edit) | A valid tag can consist of only alphanumeric characters. | `internship`<br>`network`<br>`parttime`<br>`jobPortal` |
| `ORG_ID` | [`add --rec`{:.language-sh}](#adding-recruiters---add---rec) | A valid organization ID is subject to the same requirements as the ID parameter.<br><br>It must belong to an <span class="jobby-data-class">Organization</span> contact in the address book. | `woogle123`<br>`meta_sg-1` |
| `TITLE` | [`apply`](#applying-to-organizations---apply) <br> [`edit --application`{:.language-sh}](#editing-job-applications---edit---application) | A valid title can accept multiple words separated with spaces, as long as the characters are alphanumeric. | `Software Engineer`<br>`Level 3 Engineer` |
| `DESCRIPTION` | [`apply`](#applying-to-organizations---apply) <br> [`edit --application`{:.language-sh}](#editing-job-applications---edit---application) | A valid description can accept any non-empty value. | `Senior Role`<br>`Hourly rate: $25` |
| `DEADLINE` | [`apply`](#applying-to-organizations---apply) <br> [`edit --application`{:.language-sh}](#editing-job-applications---edit---application) | A valid deadline should be a date in the form of `DD-MM-YYYY`.<br><br>The day (`DD`) and month (`MM`) can be either single or double digits. | `09-02-2022`<br>`9-2-2022`<br>`19-11-2022` |
| `STAGE` | [`apply`](#applying-to-organizations---apply) <br> [`edit --application`{:.language-sh}](#editing-job-applications---edit---application) | A valid job application stage can accept only one of the three values: `resume`, `online assessment`, `interview`.<br><br>The values are ranked in the order shown. | `resume`<br>`online assessment`<br>`interview` |
| `STATUS` | [`apply`](#applying-to-organizations---apply) <br> [`edit --application`{:.language-sh}](#editing-job-applications---edit---application) | A valid job application status can accept only one of the four values: `pending`, `offered`, `accepted`, `turned down`.<br><br>The values are ranked in the order shown. | `pending`<br>`offered`<br>`accepted`<br>`turned down` |
| `TITLE` | [`apply`](#applying-to-organizations---apply) <br><br> [`edit --application`{:.language-sh}](#editing-job-applications---edit---application) | A valid title can accept multiple words separated with spaces, as long as the characters are alphanumeric. | `Software Engineer`<br>`Level 3 Engineer` |
| `DESCRIPTION` | [`apply`](#applying-to-organizations---apply) <br><br> [`edit --application`{:.language-sh}](#editing-job-applications---edit---application) | A valid description can accept any non-empty value. | `Senior Role`<br>`Hourly rate: $25` |
| `DEADLINE` | [`apply`](#applying-to-organizations---apply) <br><br> [`edit --application`{:.language-sh}](#editing-job-applications---edit---application) | A valid deadline should be a date in the form of `DD-MM-YYYY`.<br><br>The day (`DD`) and month (`MM`) can be either single or double digits. | `09-02-2022`<br>`9-2-2022`<br>`19-11-2022` |
| `STAGE` | [`apply`](#applying-to-organizations---apply) <br><br> [`edit --application`{:.language-sh}](#editing-job-applications---edit---application) | A valid job application stage can accept only one of the three values: `resume`, `online assessment`, `interview`.<br><br>The values are ranked in the order shown. | `resume`<br>`online assessment`<br>`interview` |
| `STATUS` | [`apply`](#applying-to-organizations---apply) <br><br> [`edit --application`{:.language-sh}](#editing-job-applications---edit---application) | A valid job application status can accept only one of the four values: `pending`, `offered`, `accepted`, `turned down`.<br><br>The values are ranked in the order shown. | `pending`<br>`offered`<br>`accepted`<br>`turned down` |
| `KEYWORD` | [`find`](#searching-contacts---find) | A valid keyword is a single word that can accept any non-empty value. | `software`<br>`Ryan` |


Expand Down

0 comments on commit 8e4aa00

Please sign in to comment.