Skip to content

Commit

Permalink
Merge pull request #177 from nananakx-x/branch-v1.4.8
Browse files Browse the repository at this point in the history
Remove clutter for cs2101
  • Loading branch information
butteredyakiimo authored Nov 15, 2023
2 parents 73effbd + 69a0d0b commit 2e02785
Showing 1 changed file with 24 additions and 24 deletions.
48 changes: 24 additions & 24 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,17 +291,17 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS housing/HOUSING_TYPE availa

Parameters:

| Parameter | About | Example |
|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| `NAME` | Name of the fosterer | `Alice Tan`, `Harry Yeo` |
| `PHONE_NUMBER` | Phone number of the fosterer | `93456778`, `89067547` |
| `EMAIL` | Email of the fosterer | `[email protected]`, `[email protected]` |
| `ADDRESS` | Address of the fosterer | `Orchard road, Blk 8, #13-04` |
| `HOUSING_TYPE` | - Housing type of the fosterer<br/> - Case-sensitive<br/> - Can be HDB / Condo / Landed / nil | `HDB`, `Condo`, `Landed`, `nil` |
| `AVAILABILITY` | - Availability of the fosterer<br/> - Case-sensitive<br/> - Can be Available / NotAvailable / nil | `NotAvailable`, `Available`, `nil` |
| `ANIMAL_NAME` | - If `availability/NotAvailable`: Name of the animal fostered / nil<br/> - If `availability/Available`: nil<br/> - If `availability/nil`: nil | `Fluffball`, `nil` |
| `TYPE_OF_ANIMAL` | - Type of animal which the fosterer is currently fostering, or prefer to foster<br/> - Case-sensitive<br/> - If `availability/NotAvailable`: current.Dog / current.Cat / nil<br/> - If `availability/Available`: able.Dog / able.Cat / nil<br/> - If `availability/nil`: nil | `current.Dog`, `current.Cat`, `able.Dog`, `able.Cat`, `nil` |
| `TAG` | Tag to be associated with the fosterer | `experienced`, `urgent` |
| Parameter | About | Example |
|------------------|------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| `NAME` | Name of the fosterer | `Alice Tan`, `Harry Yeo` |
| `PHONE_NUMBER` | Phone number of the fosterer | `93456778`, `89067547` |
| `EMAIL` | Email of the fosterer | `[email protected]`, `[email protected]` |
| `ADDRESS` | Address of the fosterer | `Orchard road, Blk 8, #13-04` |
| `HOUSING_TYPE` | - Housing type of the fosterer<br/> - Case-sensitive<br/> - Can be HDB / Condo / Landed / nil | `HDB`, `Condo`, `Landed`, `nil` |
| `AVAILABILITY` | - Availability of the fosterer<br/> - Case-sensitive<br/> - Can be Available / NotAvailable / nil | `NotAvailable`, `Available`, `nil` |
| `ANIMAL_NAME` | Name of the animal fostered | `Fluffball`, `nil` |
| `TYPE_OF_ANIMAL` | - Type of animal which the fosterer is currently fostering, or prefer to foster<br/> - Case-sensitive | `current.Dog`, `current.Cat`, `able.Dog`, `able.Cat`, `nil` |
| `TAG` | Tag to be associated with the fosterer | `experienced`, `urgent` |

<div markdown="block" class="alert alert-primary">

Expand Down Expand Up @@ -520,18 +520,18 @@ Format: `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [housing/HOU

Parameters:

| Parameter | About | Example |
|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| `INDEX` | - The index of a fosterer displayed in the list obtained from a `list`/`find` command<br/> - Index must be a positive integer | `1`, `2`, `3` |
| `NAME` | Updated name of the fosterer | `Alice Tan`, `Harry Yeo` |
| `PHONE_NUMBER` | Updated Phone number of the fosterer | `93456778`, `89067547` |
| `EMAIL` | Updated email of the fosterer | `[email protected]`, `[email protected]` |
| `ADDRESS` | Updated address of the fosterer | `Orchard road, Blk 8, #13-04` |
| `HOUSING_TYPE` | - Updated housing type of the fosterer<br/> - Case-sensitive<br/> - Can be HDB / Condo / Landed / nil | `HDB`, `Condo`, `Landed`, `nil` |
| `AVAILABILITY` | - Updated availability of the fosterer<br/> - Case-sensitive<br/> - Can be Available / NotAvailable / nil | `NotAvailable`, `Available`, `nil` |
| `ANIMAL_NAME` | - If `availability/NotAvailable`: Updated name of animal fostered / nil<br/> - If `availability/Available`: nil<br/> - If `availability/nil`: nil | `Fluffball`, `nil` |
| `TYPE_OF_ANIMAL` | - Updated type of animal which the fosterer is currently fostering, or prefer to foster<br/> - Case-sensitive<br/> - If `availability/NotAvailable`: current.Dog / current.Cat / nil<br/> - If `availability/Available`: able.Dog / able.Cat / nil<br/> - If `availability/nil`: nil | `current.Dog`, `current.Cat`, `able.Dog`, `able.Cat`, `nil` |
| `TAG` | Tag to be associated with the fosterer | `experienced`, `urgent` |
| Parameter | About | Example |
|------------------|-------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| `INDEX` | - The index of a fosterer displayed in the list obtained from a `list`/`find` command<br/> - Index must be a positive integer | `1`, `2`, `3` |
| `NAME` | Updated name of the fosterer | `Alice Tan`, `Harry Yeo` |
| `PHONE_NUMBER` | Updated Phone number of the fosterer | `93456778`, `89067547` |
| `EMAIL` | Updated email of the fosterer | `[email protected]`, `[email protected]` |
| `ADDRESS` | Updated address of the fosterer | `Orchard road, Blk 8, #13-04` |
| `HOUSING_TYPE` | - Updated housing type of the fosterer<br/> - Case-sensitive<br/> - Can be HDB / Condo / Landed / nil | `HDB`, `Condo`, `Landed`, `nil` |
| `AVAILABILITY` | - Updated availability of the fosterer<br/> - Case-sensitive<br/> - Can be Available / NotAvailable / nil | `NotAvailable`, `Available`, `nil` |
| `ANIMAL_NAME` | Updated name of animal fostered | `Fluffball`, `nil` |
| `TYPE_OF_ANIMAL` | - Updated type of animal which the fosterer is currently fostering, or prefer to foster<br/> - Case-sensitive | `current.Dog`, `current.Cat`, `able.Dog`, `able.Cat`, `nil` |
| `TAG` | Tag to be associated with the fosterer | `experienced`, `urgent` |

<div markdown="block" class="alert alert-primary">

Expand Down Expand Up @@ -740,7 +740,7 @@ In the example above, Alex, Bernice and Charlotte are the fosterers deleted.
### Sorting fosterers: `sort`

Sorts your list of fosterers alphabetically by name, where uppercase letters come before lowercase letters
(i.e. `annie tan` will be sorted behind `Jerry Tan`).
(i.e. `"annie tan"` will be sorted behind `"Jerry Tan"`).

Format: `sort`

Expand Down

0 comments on commit 2e02785

Please sign in to comment.