Skip to content

Commit

Permalink
Add acceptable values to user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
teoks0199 committed Sep 21, 2023
1 parent 5bf74dd commit e70dc8b
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ You can update or delete tasks if you made a mistake.

Adds a ToDo task to the task list.

Format: `todo <description>`
Format: `todo <description>`

Acceptable values: `<description>`: String

Example of usage:

Expand All @@ -45,6 +47,8 @@ Adds a Deadline task to the task list.

Format: `deadline <description> /by <YYYY-MM-DD>`

Acceptable values: `<description>`: String, `<YYYY-MM-DD>`: Date in the format YYYY-MM-DD

Example of usage:

`deadline return book /by 2020-09-20`
Expand All @@ -64,6 +68,8 @@ Adds an Event task to the task list.

Format: `event <description> /from <YYYY-MM-DD> /to <YYYY-MM-DD>`

Acceptable values: `<description>`: String, `<YYYY-MM-DD>`: Date in the format YYYY-MM-DD

Example of usage:

`event carnival /from 2020-09-20 /to 2020-09-21`
Expand Down Expand Up @@ -103,6 +109,8 @@ Marks a task as done.

Format: `mark <task index>`

Acceptable values: `<task index>`: Positive integer less than or equal to the number of tasks in the list

Example of usage:

`mark 1`
Expand All @@ -121,6 +129,8 @@ Marks a task as not done.

Format: `unmark <task index>`

Acceptable values: `<task index>`: Positive integer less than or equal to the number of tasks in the list

Example of usage:

`unmark 1`
Expand All @@ -139,6 +149,8 @@ Deletes a task from the task list.

Format: `delete <task index>`

Acceptable values: `<task index>`: Positive integer less than or equal to the number of tasks in the list

Example of usage:

`delete 1`
Expand All @@ -158,6 +170,8 @@ Find tasks by searching for a keyword.

Format: `find <keyword>`

Acceptable values: `<keyword>`: String

Example of usage:

`find book`
Expand All @@ -184,6 +198,8 @@ Format:

`update <task index> /to <YYYY-MM-DD>`

Acceptable values: `<task index>`: Positive integer less than or equal to the number of tasks in the list, `<YYYY-MM-DD>`: Date in the format YYYY-MM-DD

Example of usage:

`update 2 /from 2023-11-08`
Expand Down

0 comments on commit e70dc8b

Please sign in to comment.