Add deleting flashcards to UG

Author: wendelinwemhoener

docs/UserGuide.md

@@ -9,80 +9,92 @@ taking.
 ## Quick Start
 
 1. Ensure that you have Java 11 or above installed.
-2. Down the latest jar from [the latest release on GitHub]
-   (https://github.com/AY2324S1-CS2113-F11-3/tp/releases).
+2. Down the latest jar from [the latest release on GitHub](https://github.com/AY2324S1-CS2113-F11-3/tp/releases).
 3. Run the jar via `java -jar duke.jar`
 
-## General explanation of flashcards
-
 ## Features
 
-### Listing all flashcards: `list flashcards`
-
-Prints out a list of all flashcards.
-
-Format: `list flashcards`
+### Flashcard-related features
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+#### General explanation of flashcards
 
-Format: `todo n/TODO_NAME d/DEADLINE`
-
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.
-
-Example of usage:
+#### Listing all flashcards: `list flashcards`
 
-`todo n/Write the rest of the User Guide d/next week`
+Prints out a list of all flashcards that shows each flashcard's front text 
+and back text as well as its id and current difficulty level.
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+Format: `list flashcards`
 
-### Creating a new flashcard: `create flashcard`
+#### Creating a new flashcard: `create flashcard`
 
 Starts the process of adding a new flashcard.
 
-After entering this command, you are prompted to first input the front page 
-text (once you have typed it out, submit it by pressing <ENTER>) and then the 
-back page text (once you have typed it out, submit it by pressing <ENTER>) of 
+After entering this command, you are prompted to first input the front page
+text (once you have typed it out, submit it by pressing <ENTER>) and then the
+back page text (once you have typed it out, submit it by pressing <ENTER>) of
 your new flashcard.
 
-After you've done this, a success message will be printed out. This 
+After you've done this, a success message will be printed out. This
 indicates that a new flashcard has been successfully created and saved.
 
 Format: `create flashcard`
 
-### Reviewing your flashcards: `review flashcards`
+#### Reviewing your flashcards: `review flashcards`
 
 Starts the process of reviewing flashcard.
 
-After entering this command, you are prompted to select your exact review 
-mode from 3 choices:
+After entering this command, you are prompted to select your exact review
+mode from two choices:
 
 - `random mode`: Randomly selects flashcards to review
-- `spaced repetition mode`: Which flashcards are shown depends on how well 
-  you previously knew them. Flashcards which you couldn't remember well are 
-  shown more often, while flashcards which you remembered well are shown 
+- `spaced repetition mode`: Which flashcards are shown depends on how well
+  you previously knew them. Flashcards which you couldn't remember well are
+  shown more often, while flashcards which you remembered well are shown
   less often.
-- `review by tag mode`: Randomly selects flashcards with a certain tag to review
 
-Input `a` to choose `random mode`, input `b` to choose `spaced repetition 
-mode` and input `c` to choose `review by tag mode`.
+Input `a` to choose `random mode`, or input `b` to choose `spaced repetition
+mode`.
 
-Once you've selected a review mode, the actual review begins: the front page 
-of a flashcard is shown to you. You should now try and think of the answer 
-(the text on the back page of the flashcard); and once you're ready, press 
+Once you've selected a review mode, the actual review begins: the front page
+of a flashcard is shown to you. You should now try and think of the answer
+(the text on the back page of the flashcard); and once you're ready, press
 <ENTER> to compare it to the actual back page.
 
+In spaced repetition mode, after you have revealed the back page of a 
+flashcard, you are prompted to rate how to difficult it was to remember. 
+Select `E` if it was easy, `M` if it was moderately hard and `H` if it was 
+quite hard. This information is used to adjust the difficulty of the 
+flashcard you just reviewed.
+
 Now, the process repeats and the next flashcard is shown to you.
 
-If you want to quit the review process, simply input `q` or `quit` instead 
+If you want to quit the review process, simply input `q` or `quit` instead
 of pressing <ENTER> to reveal the back page.
 
 Format: `create flashcard`
 
-## General Explanation of Calendar Features
+#### Deleting a flashcard
 
-## Features
+Starts the process of deleting a flashcard.
+
+After entering this command, you are prompted to input the id of the 
+flashcard you want to delete. Input it into the terminal and then press enter.
+
+If it was a valid id, the flashcard with that id is deleted; otherwise, an 
+error message is shown and you are prompted to retry.
+
+Format: `delete flashcard`
+
+#### Deleting all flashcards: `delete all flashcards`
+
+Deletes all flashcards that you have added so far.
+
+Format: `delete all flashcards`
+
+
+
+
+### General Explanation of Calendar Features
 
 Here is your features list:
 
@@ -92,7 +104,24 @@ Here is your features list:
 
 Users can use the above features to handle their events
 
-### Add an Event to the Calendar
+#### Adding a todo: `todo`
+
+Adds a new item to the list of todo items.
+
+Format: `todo n/TODO_NAME d/DEADLINE`
+
+* The `DEADLINE` can be in a natural language format.
+* The `TODO_NAME` cannot contain punctuation.
+
+Example of usage:
+
+`todo n/Write the rest of the User Guide d/next week`
+
+`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+
+
+
+#### Add an Event to the Calendar
 
 **Adds an event to the calendar with start and end time** 
 
@@ -110,7 +139,7 @@ Users can use the above features to handle their events
 + `When does it start?: 2023-12-20T12:30:30`
 + `When does it end?: 2023-12-20T12:40:30`
 
-### Delete an Event From the Calendar
+#### Delete an Event From the Calendar
 
 **deletes an event from the calendar with event name**
 
@@ -124,7 +153,7 @@ Users can use the above features to handle their events
 + `Enter your command: delete event`
 + `Enter the event name: Do HW`
 
-### Delete All Events From the Calendar
+#### Delete All Events From the Calendar
 
 **deletes all events from the calendar**
 
@@ -136,11 +165,11 @@ Users can use the above features to handle their events
 
 + `Enter your command: delete all events`
 
-### Find an Event From the Calendar
+#### Find an Event From the Calendar
 
 **finds an event from the calendar**
 
-#### Usage
+##### Usage
 
 + Format: `find event`
 + What event are you looking for?: `event name`
@@ -150,7 +179,7 @@ Users can use the above features to handle their events
 + `Enter your command: find event`
 + `What event are you looking for?: Do HW`
 
-### List All Events From the Calendar
+#### List All Events From the Calendar
 
 **Lists all events from the calendar**