Skip to content

Commit

Permalink
Make tables neater
Browse files Browse the repository at this point in the history
  • Loading branch information
@nananakx-x
nananakx-x committed Nov 2, 2023
1 parent 59462a2 commit 4bf89da
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 24 deletions.
12 changes: 6 additions & 6 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -333,12 +333,12 @@ Currently, the default add command may be too long for an average typer to key i

We are also planning to shorten some input parameters when adding or editing a fosterer:

| Current | Enhancement |
|---------------------------|-----------|
| availability/Available | avail/true |
| availability/NotAvailable | avail/false |
| availability/nil | avail/nil |
| animalType/ | type/ |
| Current | Enhancement |
|---------------------------|--------------|
| availability/Available | avail/true |
| availability/NotAvailable | avail/false |
| availability/nil | avail/nil |
| animalType/ | type/ |

### Case-sensitivity of Inputs
Currently, the fields and parameters for housing, availability and animal type are case-sensitive. An enhancement to this would be to make these fields and their parameters case-insensitive to improve the user experience. Moreover, the aforementioned enhancements to shorten the command format will also be case-insensitive.
Expand Down
36 changes: 18 additions & 18 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -611,21 +611,21 @@ If your changes to the data file makes its format invalid, Foster Family will di

## Command summary

| Action | Format | Examples |
|-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Help** | `help` | - |
| **Add** from main window | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS housing/HOUSING_TYPE availability/AVAILABILITY animal/ANIMAL_NAME animalType/TYPE_OF_ANIMAL [t/TAG]…` | `add n/Jerry Tan p/98765412 e/[email protected] a/Baker street, block 5, #27-01 housing/HDB availability/NotAvailable animal/Dexter animalType/current.Cat t/Urgent` |
| **Add** from profile page | `add` | - |
| **List** or **Find** | `list`, `find` | `list`, `find`, `list available`, `find available` |
| **View Profile** | `view INDEX` | `view 1` |
| **Save updated fosterer details** | `save` | - |
| **Edit** from main window | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [housing/HOUSING_TYPE] [availability/AVAILABILITY] [animal/ANIMAL_NAME] [animalType/TYPE_OF_ANIMAL] [t/TAG…]` | `edit 2 n/James Lee e/[email protected]` |
| **Edit** from profile page | `edit INDEX` | `edit 1` |
| **Delete** | `delete INDEX [INDEX...]` | `delete 1 2 3` |
| **Sort** | `sort` | - |
| **View Available Fosterer Statistics** | `stats avail` | - |
| **View Current Fosterer Statistics**| `stats current` | - |
| **View Housing Statistics** | `stats housing` | - |
| **Undo** | `undo` | - |
| **Reset** | `reset`, followed by `reset confirm` | - |
| **Exit** from application / profile page | `exit` | - |
| Action | Format | Examples |
|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Help** | `help` | - |
| **Add** from main window | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS housing/HOUSING_TYPE availability/AVAILABILITY animal/ANIMAL_NAME animalType/TYPE_OF_ANIMAL [t/TAG]…` | `add n/Jerry Tan p/98765412 e/[email protected] a/Baker street, block 5, #27-01 housing/HDB availability/NotAvailable animal/Dexter animalType/current.Cat t/Urgent` |
| **Add** from profile page | `add` | - |
| **List** or **Find** | `list`, `find` | `list`, `find`, `list available`, `find available` |
| **View Profile** | `view INDEX` | `view 1` |
| **Save updated fosterer details** | `save` | - |
| **Edit** from main window | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [housing/HOUSING_TYPE] [availability/AVAILABILITY] [animal/ANIMAL_NAME] [animalType/TYPE_OF_ANIMAL] [t/TAG…]` | `edit 2 n/James Lee e/[email protected]` |
| **Edit** from profile page | `edit INDEX` | `edit 1` |
| **Delete** | `delete INDEX [INDEX...]` | `delete 1 2 3` |
| **Sort** | `sort` | - |
| **View Available Fosterer Statistics** | `stats avail` | - |
| **View Current Fosterer Statistics** | `stats current` | - |
| **View Housing Statistics** | `stats housing` | - |
| **Undo** | `undo` | - |
| **Reset** | `reset`, followed by `reset confirm` | - |
| **Exit** from application / profile page | `exit` | - |

0 comments on commit 4bf89da

Please sign in to comment.