Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove clutter for cs2101 #177

Merged
merged 2 commits into from
Nov 15, 2023
Merged

Remove clutter for cs2101 #177

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80a0c6d
Remove clutter for cs2101
nananakx-x Nov 15, 2023
69a0d0b
Resolve suggestions
nananakx-x Nov 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions docs/UserGuide.md
View file
Open in desktop
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