Update ug #178

caitlinjee · 2020-10-25T17:48:04Z

No description provided.

…into branch-update-ugdg

codecov-io · 2020-10-25T17:49:38Z

Codecov Report

Merging #178 into master will decrease coverage by 0.21%.
The diff coverage is 8.33%.

@@             Coverage Diff              @@
##             master     #178      +/-   ##
============================================
- Coverage     64.54%   64.32%   -0.22%     
  Complexity      685      685              
============================================
  Files           116      116              
  Lines          2383     2391       +8     
  Branches        294      294              
============================================
  Hits           1538     1538              
- Misses          733      741       +8     
  Partials        112      112

Impacted Files	Coverage Δ	Complexity Δ
...seedu/address/logic/commands/AddRecipeCommand.java	`100.00% <ø> (ø)`	`8.00 <0.00> (ø)`
...va/seedu/address/logic/commands/CommandResult.java	`70.90% <ø> (ø)`	`18.00 <0.00> (ø)`
...seedu/address/logic/commands/EatRecipeCommand.java	`89.47% <ø> (ø)`	`9.00 <0.00> (ø)`
.../address/logic/commands/EditIngredientCommand.java	`83.67% <ø> (ø)`	`13.00 <0.00> (ø)`
...eedu/address/logic/commands/EditRecipeCommand.java	`92.40% <ø> (ø)`	`13.00 <0.00> (ø)`
...du/address/logic/commands/SearchRecipeCommand.java	`100.00% <ø> (ø)`	`6.00 <0.00> (ø)`
...du/address/logic/commands/SelectRecipeCommand.java	`0.00% <0.00%> (ø)`	`0.00 <0.00> (ø)`
src/main/java/seedu/address/ui/MainWindow.java	`0.00% <0.00%> (ø)`	`0.00 <0.00> (ø)`
...u/address/logic/commands/AddIngredientCommand.java	`92.30% <100.00%> (ø)`	`14.00 <1.00> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4dff64a...486206c. Read the comment docs.

oliviajohansen · 2020-10-26T02:32:08Z

docs/UserGuide.md

+  e.g. in `addR`, `add` is in small letters while `R` is in capital letters.
+
+* Words in `UPPER_CASE` are the parameters to be supplied by you.<br>
+  e.g. in `addR n/NAME`, `NAME` is a parameter which can be used as `addR n/salad`.

 * Items in square brackets are optional.<br>
  e.g `n/NAME [t/TAG]` can be used as `n/Salad t/healthy` or as `n/Salad`.


Items with … after them can be used more than 1 times.
e.g. [t/TAG]… can be used as t/healthy, t/healthy t/low calories etc.

Not sure why this is not shown here but can change the ',' after t/healthy to 'or' so its clearer? and remove the etc to make it consistent

ok good idea

jiaqi20 · 2020-10-26T05:58:46Z

docs/UserGuide.md

+   * Note: If you want to use an image that has been saved in your computer, you have to specify the **absolute path** of the image, and add file:// in front of the file path. Then, replace IMAGE in img/IMAGE with the file path of your image, e.g. img/file:///D:/myimages/wishful/data/myimage.png.
+   * Note: If you input an invalid file path, Wishful Shrinking will replace the image with a default image.
+   * Note: If you want to use a url as the image, make sure that you are connected to the internet on your computer, and that the url is the **image address** (starting with https:// and ending with .jpg/jpeg/png). The image will be downloaded into Wishful Shrinking's data folder if there is internet connection.
+   * Note: If you input an invalid url, or input a url while there is no internet, Wishful Shrinking cannot add the image to the recipe. You have to connect to the internet, or check that your url is a valid image address.


Should we include a table of built in image paths, e.g. images/healthy1.jpg together with their respective descriptions, just in case users want to use our sample images?

for the last Note, if input invalid url/valid url without internet, Wishful Shrinking will use default image instead.

oliviajohansen · 2020-10-26T06:02:08Z

docs/UserGuide.md

@@ -26,26 +26,36 @@ Choose a topic from the table of contents to get started on your Wishful Shrinki

 1. Ensure your computer has Java `11` or above installed.

-2. Download the latest `wishfulShrinking.jar` from [here](https://github.com/AY2021S1-CS2103T-W10-2/tp).
+2. Download the latest `wishfulShrinking.jar` from [here](https://github.com/AY2021S1-CS2103T-W10-2/tp/releases).

 3. Copy the file to an empty folder you want to use as the _home folder_.

 4. **Double-click** the jar file to start the app OR start the app using **CLI** and type `java -jar <jar file name>.jar`.<br>


should we specify our jar file name as wishfulShrinking.jar?

what do you mean by this?

oliviajohansen · 2020-10-26T06:05:01Z

docs/UserGuide.md

+   * Command Result: The Command Result box will show the result of your input into the Command Box.
+   * Command Box: Here is where you will type all your commands.
+
+6. Type the command in the command box and press `Enter` to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>


can remove the eg help since the examples are all already below?

I think this eg is ok since it specifies that the user has to press enter also? below it doesnt specify the enter

TianYong-Goh · 2020-10-26T06:43:49Z

docs/UserGuide.md

+
+* This command closes the left drawer that is opened after you have selected a recipe.
+* Note: Nothing will happen if you use this command when the left drawer is not opened.
+<br><br><br>

 ### Deleting a recipe : `deleteR`


Can add on explanation that deleteR will not affect the consumption list.

oliviajohansen · 2020-10-26T06:12:09Z

docs/UserGuide.md

+  e.g. in `addR`, `add` is in small letters while `R` is in capital letters.
+
+* Words in `UPPER_CASE` are the parameters to be supplied by you.<br>
+  e.g. in `addR n/NAME`, `NAME` is a parameter which can be used as `addR n/salad`.

 * Items in square brackets are optional.<br>
  e.g `n/NAME [t/TAG]` can be used as `n/Salad t/healthy` or as `n/Salad`.



The image above is a labeled diagram of each of Wishful Shrinking's components. Below is a brief explanation on each of the components.

Should separate the image title from the second part. (Image title/descr should be in own line)

oliviajohansen · 2020-10-26T06:18:07Z

docs/UserGuide.md

-    * there is a mandatory space before `-` 
+Format: `addR n/NAME i/INGREDIENT [ -QUANTITY][, MORE INGREDIENTS [ -QUANTITY]] c/CALORIES img/IMAGE inst/INSTRUCTION... [t/TAG]...`
+
+* `INGREDIENT` can take in an optional `Quantity` e.g. i/Tomato -2 whole.


QUANTITY only accepts alphanumeric characters, forward slashes and full stops.

oliviajohansen · 2020-10-26T06:24:21Z

docs/UserGuide.md

+   * Note: If you want to use an image that has been saved in your computer, you have to specify the **absolute path** of the image, and add file:// in front of the file path. Then, replace IMAGE in img/IMAGE with the file path of your image, e.g. img/file:///D:/myimages/wishful/data/myimage.png.
+   * Note: If you input an invalid file path, Wishful Shrinking will replace the image with a default image.
+   * Note: If you want to use a url as the image, make sure that you are connected to the internet on your computer, and that the url is the **image address** (starting with https:// and ending with .jpg/jpeg/png). The image will be downloaded into Wishful Shrinking's data folder if there is internet connection.
+   * Note: If you input an invalid url, or input a url while there is no internet, Wishful Shrinking cannot add the image to the recipe. You have to connect to the internet, or check that your url is a valid image address.
 * Each `INSTRUCTION` is separated by a `.` e.g. instr/Cook. Eat.


Each INSTRUCTION could be confusing bc there is only 1 instr tag

INSTRUCTION will take in a series of instruction text and Wishful Shrinking will automatically separate each step of the instruction based on the end of a sentence, indicated by a .. e.g. instr/Cook pasta. Serve immediately.

oliviajohansen · 2020-10-26T06:30:19Z

docs/UserGuide.md

+* Note: The index **must be a positive integer** e.g. 1, 2, 3......
+
+Examples:
+* `selectR 1` shows the 1st recipe in full view (left drawer), as well as in the command result box on the right.


not sure if necessary to write this "command result box on the right." since the messages in the command result box is true for all commands.

oliviajohansen · 2020-10-26T06:31:45Z

docs/UserGuide.md

 ![help message](images/helpMessage.png)
+<br>The image above is Wishful Shrinking's help window.<br><br><br>


place image title/descr before image

oliviajohansen · 2020-10-26T06:56:29Z

docs/UserGuide.md

+* Note: The index **must be a positive integer** e.g. 1, 2, 3......
+* Note: All fields are optional, but **at least one** of the fields must be present. There can be any number of fields to edit.
+* Note: You are not allowed to edit a recipe into another recipe that is already in the recipe list.
+* Note: Use carefully as this command will override the existing values with the new values.


Note: Specified fields will permanently override existing values with the new values. To directly modify existing recipe ... link to the tip below: Tip: Typing editR INDEX and then hitting Enter will insert the information of the recipe at the specified INDEX in...

oliviajohansen · 2020-10-26T07:07:10Z

docs/UserGuide.md

 Examples:
-* `recommend` returns `salad` with ingredients `lettuce`, `onion` and `tomato` only if the user has all `lettuce`, `onion` and `tomato` in the fridge
+* `recommend` returns the recipe `salad` with ingredients `lettuce`, `onion` and `tomato` **only if** you have all `lettuce`, `onion` and `tomato` in your fridge.


recommend returns the recipe salad with ingredients lettuce, onion and tomato since the example user has all the ingredients: lettuce, onion and tomato in their fridge.

oliviajohansen · 2020-10-26T07:09:48Z

docs/UserGuide.md


 Format: `recommend`

+* Note: Recipes will only be recommend if you have all the ingredients in the recipe with the exact same name in your fridge.


Note: Ingredient quantity is not taken into account when determining if an ingredient is present or absent in your fridge.

oliviajohansen · 2020-10-26T07:11:51Z

docs/UserGuide.md


 Format: `addF i/INGREDIENT [ -QUANTITY][, MORE INGREDIENTS [ -QUANTITY]]`

+* `INGREDIENT` can take in an optional `Quantity` e.g. i/Tomato -2 whole.


QUANTITY only accepts alphanumeric characters, forward slashes and full stops.

oliviajohansen · 2020-10-26T07:16:25Z

docs/UserGuide.md

-* Note: Use carefully as this command will override the existing values with the new values
-* Tip: Use `editF INDEX` to directly modify the existing ingredient
+* Note: The index refers to the index number shown in the displayed ingredient list.
+* Note: The index **must be a positive integer** e.g. 1, 2, 3......


same as above edit

caitlinjee and others added 10 commits October 24, 2020 22:42

Update commandresult for selectcommand

a26bca7

Merge branch 'master' of https://github.com/AY2021S1-CS2103T-W10-2/tp …

3d25534

…into branch-update-ugdg

Merge branch 'master' of https://github.com/AY2021S1-CS2103T-W10-2/tp …

9b30d20

…into branch-update-ugdg

Merge branch 'master' of https://github.com/AY2021S1-CS2103T-W10-2/tp …

8cbc15f

…into branch-update-ugdg

Update release link

9a8fa75

Merge branch 'master' of https://github.com/AY2021S1-CS2103T-W10-2/tp …

18df95c

…into branch-update-ugdg

Add UI images

35fea36

Update ug

5aaddba

Make ug more reader friendly

44ddac8

Update command usage message to match ug

f9c21f1

caitlinjee added this to the v1.3 milestone Oct 25, 2020

caitlinjee self-assigned this Oct 25, 2020

This was linked to issues Oct 25, 2020

Add ui images to ug #139

Closed

Add image of ui with explained components to ug #144

Closed

Add more information for commands to ug #150

Closed

Make phrasing in ug consistent #152

Closed

Update user guide (AddRecipeCommand) #156

Closed

oliviajohansen reviewed Oct 26, 2020

View reviewed changes

caitlinjee and others added 4 commits October 26, 2020 12:31

Update ug following comments

0d8ad27

Update caloriesimage

b6635cb

Add labels to images

cca1e72

Update addrecipecommand description

486206c

jiaqi20 reviewed Oct 26, 2020

View reviewed changes

oliviajohansen reviewed Oct 26, 2020

View reviewed changes

TianYong-Goh approved these changes Oct 26, 2020

View reviewed changes

oliviajohansen approved these changes Oct 26, 2020

View reviewed changes

Update ug according to comments

e7c422c

daongochieu2810 approved these changes Oct 26, 2020

View reviewed changes

jiaqi20 approved these changes Oct 26, 2020

View reviewed changes

jiaqi20 merged commit b1d60d8 into AY2021S1-CS2103T-W10-2:master Oct 26, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update ug #178

Update ug #178

caitlinjee commented Oct 25, 2020

codecov-io commented Oct 25, 2020 •

edited

oliviajohansen Oct 26, 2020 •

edited

caitlinjee Oct 26, 2020

jiaqi20 Oct 26, 2020

jiaqi20 Oct 26, 2020

oliviajohansen Oct 26, 2020

caitlinjee Oct 26, 2020

oliviajohansen Oct 26, 2020

caitlinjee Oct 26, 2020

TianYong-Goh Oct 26, 2020

oliviajohansen Oct 26, 2020

oliviajohansen Oct 26, 2020

oliviajohansen Oct 26, 2020

oliviajohansen Oct 26, 2020

oliviajohansen Oct 26, 2020

oliviajohansen Oct 26, 2020

oliviajohansen Oct 26, 2020

oliviajohansen Oct 26, 2020

oliviajohansen Oct 26, 2020

oliviajohansen Oct 26, 2020

		![help message](images/helpMessage.png)
		<br>The image above is Wishful Shrinking's help window.<br><br><br>


		Format: `recommend`

		* Note: Recipes will only be recommend if you have all the ingredients in the recipe with the exact same name in your fridge.


		Format: `addF i/INGREDIENT [ -QUANTITY][, MORE INGREDIENTS [ -QUANTITY]]`

		* `INGREDIENT` can take in an optional `Quantity` e.g. i/Tomato -2 whole.

Update ug #178

Update ug #178

Conversation

caitlinjee commented Oct 25, 2020

codecov-io commented Oct 25, 2020 • edited

Codecov Report

oliviajohansen Oct 26, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Oct 25, 2020 •

edited

oliviajohansen Oct 26, 2020 •

edited