From 4bf89da4d26f5c2e70a0adce61e1ba93917609cb Mon Sep 17 00:00:00 2001 From: nananakx-x Date: Thu, 2 Nov 2023 19:51:33 +0800 Subject: [PATCH] Make tables neater --- docs/DeveloperGuide.md | 12 ++++++------ docs/UserGuide.md | 36 ++++++++++++++++++------------------ 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 524703e9cc1..343f3719679 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -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. diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b42283cb720..c209916705f 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -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/jerry123@example.com 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/jameslee@example.com` | -| **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/jerry123@example.com 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/jameslee@example.com` | +| **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` | - |