From 4e1b62ecb0a4083719ae76254697ab9dd6b67805 Mon Sep 17 00:00:00 2001 From: Jason Baek Date: Mon, 13 Nov 2023 19:11:13 +0800 Subject: [PATCH 1/2] Minor screenshot size fixes for UG --- docs/UserGuide.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index ff99cc7cf1a..fef0f7167e2 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -44,7 +44,7 @@ about animals in a shelter easily. A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
- Default View + Default View
@@ -134,12 +134,12 @@ Displays either a link to this User Guide in a pop-up, or the usage guide of the `help` will produce a link to the User Guide in a pop-up.
- Pop-up + Pop-up
`help add` will show usage guide of all commands that partial match with `add`.
- help add + help add
**Upon failure:** @@ -176,7 +176,7 @@ add n/NAME i/ID g/SEX s/SPECIES b/BREED db/DOB da/DOA * `add n/Tofu i/1242 g/female db/2023-04-01 da/2023-05-25 s/cat b/British Shorthair` adds Tofu to the list.
- Add animal example + Add animal example
**Upon failure:** @@ -226,7 +226,7 @@ Deletes the specified animal from the animal catalog. * `delete 2` deletes the animal at `INDEX 2`.
- Delete animal example + Delete animal example
**Upon failure:** @@ -263,13 +263,13 @@ Edits animals specified by the index with the newly specified prefix attributes. * `edit 2 n/Pookie` edits the name of the animal at `INDEX 2` to be `Pookie`.
- Edit animal name + Edit animal name
* `edit 1 s/Dog b/Poodle` edits the species of the animal at `INDEX 1` to be `Dog` and the breed to be `Poodle`.
- Edit animal species and breed + Edit animal species and breed
**Upon failure:** @@ -310,14 +310,14 @@ Searches animals that are filtered using the specified prefixes. **Upon success:** * `search n/Bear` returns all animals with the name `Bear`, not animals whose species is `Bear`
- Search for animals named 'Bear' + Search for animals named 'Bear'
* `search n/Pookie b/Poodle` returns all animals with the name `Pookie` and is of the breed `Poodle`
- Search for animals with multiple prefixes + Search for animals with multiple prefixes
**Upon failure:** @@ -347,7 +347,7 @@ Adds a specific new task to the task list of an animal. * `addtask 1 Feed Pookie` adds a task with name `Feed Pookie` to the task list of the first animal.
- Add task example + Add task example
**Upon failure:** @@ -388,7 +388,7 @@ from animal with index 12, but because there is a missing `TASK_INDEX`, the comm * `deletetask 1 1` deletes the first task from the first animal in the list
- Delete task example + Delete task example
@@ -435,7 +435,7 @@ Marks the specified task as done. * `mark 2 1 2` marks the first and second task of the second animal as done.
- Mark task example + Mark task example
@@ -485,7 +485,7 @@ Marks the specified task as uncompleted. * `unmark 3 1 2` marks the first and second task of the third animal as uncompleted.
- Unmark task example + Unmark task example
@@ -534,14 +534,14 @@ The animal cell whose details are currently being displayed in the detail view w * Selecting an animal in the first cell will display the details as shown below, with the selected cell highlighted in orange.
- Selected animal view + Selected animal view
* `edit 2 n/Pooh` will automatically cause the animal at `INDEX 2` to show in the detailed view, since it is a command in the list of animal-specific commands.
- Detailed view + Detailed view
@@ -558,6 +558,7 @@ Pawfection data are saved in the hard disk automatically after any command that Pawfection data are saved automatically as a JSON file `[JAR file location]/data/animalcatalog.json`. Advanced users are welcome to update data directly by editing that data file. + *Caution:* If your changes to the data file makes its format invalid, Pawfection will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it. From 40395ca4051d894b40263df3ab0e8562c54b3460 Mon Sep 17 00:00:00 2001 From: Jason Baek Date: Mon, 13 Nov 2023 19:16:10 +0800 Subject: [PATCH 2/2] Add attributes of animal to toc --- docs/UserGuide.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index fef0f7167e2..b7b3bf9eb0e 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -13,6 +13,7 @@ about animals in a shelter easily. - [Quick start](#quick-start) - [Features](#features) + - [Attributes of `Animal`](#attributes-of-animal) - [Program usage help: `help`](#program-usage-help-help) - [Adding an animal: `add`](#adding-an-animal-add) - [Listing all animals: `list`](#listing-all-animals-list) @@ -93,6 +94,10 @@ about animals in a shelter easily. + +For longer error messages stated in the user guide, they have been shortened for brevity by displaying only the first few words followed by ellipsis. + + ### Attributes of `Animal` Summarized in the table below are the attributes of `Animal` along with their constraints. Users are encouraged to read through this table for an idea of what the attributes are supposed to look like, and refer to this table if they are unsure. @@ -112,10 +117,6 @@ this table for an idea of what the attributes are supposed to look like, and ref - -For longer error messages stated in the user guide, they have been shortened for brevity by displaying only the first few words followed by ellipsis. - - ### Program usage help: `help` Displays either a link to this User Guide in a pop-up, or the usage guide of the specified command.