Skip to content

Commit

Permalink
Fix docs formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
tituschewxj committed Feb 20, 2024
1 parent 16b9901 commit 620a135
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
7 changes: 4 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ Undoes a change that you have made.
> ```
>
> * This undoes the previous change, which is creating a todo called `assignment`,
> * The Task list is rolled back to its previous state, before that todo was created.
> * The task list is rolled back to its previous state, before that todo was created.
> **Example**
>
Expand All @@ -223,7 +223,7 @@ Undoes a change that you have made.
> * This undoes the previous two changes, which is creating a deadline called `homework`
> and a todo called `assignment`.
> * `list` does not modify the anything, so is not included as a change.
> * The Task list is rolled back to its previous state, before the todo and deadline were created.
> * The task list is rolled back to its previous state, before the todo and deadline were created.
### Resizing your chatbot
Expand Down Expand Up @@ -283,6 +283,7 @@ Command refers to some text that a user can input, which results in the executio
and displays something in the chat. The execution can be either successful or unsuccessful (gives error message).
* `name` refers to a word, or a group of words, that are within brackets or after a forward slash.
* The `name` at the start of a command refers to the name of the command.
* `name`s are trimmed, whitespace before and after it are removed.
* Square brackets (`[`, `]`) around an argument represents an **optional** argument, which does not have to be included.
* Angled brackets (`<`, `>`) around a `name` represents the name of the value of the argument.
* Forward slash `/` followed by a `name` represents the name of the argument.
Expand All @@ -295,4 +296,4 @@ Argument refers to some text that starts with a forward slash, followed by possi
* If the **same** argument is provided more than once, only the first instance of that argument is read.
For example, in `deadline cs2103t quiz /by today /by tomorrow`, the `by_date` is read as `today`,
and `tomorrow` is ignored.
* Invalid or missing arguments (and their values), will display an error to the user.
* Invalid or missing arguments (and their values), will display an error to the user.
5 changes: 2 additions & 3 deletions src/main/java/chatbot/action/Action.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@
* An Action encapsulates the behaviour of a {@link Command} and it's {@link Argument}(s).
* <li>An action may be invalid.
* <li>An action can be executed, with validation checks.
* <p>
* <code>ModifyAction <: Action</code>
* <code>IndexableAction <: ModifyAction</code>
* <li><code>ModifyAction <: Action</code>
* <li><code>IndexableAction <: ModifyAction</code>
*
* @author Titus Chew
*/
Expand Down

0 comments on commit 620a135

Please sign in to comment.