From ec17a9b156486943877c2670df323023ed5cc098 Mon Sep 17 00:00:00 2001 From: NgChunMan Date: Thu, 26 Oct 2023 07:54:48 +0800 Subject: [PATCH 1/4] Modify user guide --- docs/UserGuide.md | 145 +++++++++++++++++++++++++++++----------------- 1 file changed, 92 insertions(+), 53 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 712d1a1b5b0..4fbe8aca031 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1,7 +1,6 @@ --- - layout: default.md - title: "User Guide" - pageNav: 3 +layout: page +title: User Guide --- # ProfBook User Guide @@ -91,6 +90,12 @@ Acceptable values for each parameter: `SPECIFIED_PATH`: - must be valid path +`SPECIFIED_STUDENT_PATH`: +- must be valid path + +`SPECIFIED_DESTINATION_PATH`: +- must be valid path + `NAME`: - must be a non-empty string @@ -103,6 +108,9 @@ Acceptable values for each parameter: `ADDRESS`: - must be a non-empty string +`TASKINDEX`: +- must be a valid index starts from 1 + -------------------------------------------------------------------------------------------------------------------- # General Commands @@ -204,59 +212,64 @@ Specified path: ### Move students into/out of the group: `mv` -Moves student from a group to another group - -Format `mv [StudentID] -source [source group] -dest [destination group]` +Moves student from one group to another group -Acceptable values for each parameter: -StudentID: +Format: `mv SPECIFIED_STUDENT_PATH SPECIFIED_DESTINATION_PATH` -- must be a 4 digits number follow with any letter +#### Acceptable values for each parameter: -source group: +Specified student path: -- must be a valid non-empty string starting with grp- +- must be a valid path to a student that user wants to move -destination group: +Specified destination path: -- must be a valid non-empty string starting with grp- +- must be a valid path to a group that user wants to move the student to -Output if command fails +#### Output if command fails -- pop up message indicate error when moving student with id 0123Y from grp-1 to grp-2 +- Pop up message indicating either: + - Invalid command format + - No such student to move + - Invalid destination path -Output if command succeeds +#### Output if command succeeds -- pop up message indicates successfully moving student with id 0123Y from grp-1 to grp-2 +- Pop up message indicating successfully moving student from one group to another group -Examples: -`mv 0123Y -source grp-1 -dest grp-2` +#### Examples: +- When user is at the root directory `~` and keys in the following command, student with specified path `~/grp-001/0123Y` will be moved from grp-001 to grp-002: + - `mv grp-001/0123Y grp-002` -- This command will move a student with value id 0123Y within the groups or from Ungroup to Group. +- When user is at the group directory `~/grp-001` and keys in the following command, student with specified path `~/grp-001/0123Y` will be moved from grp-001 to grp-002: + - `mv 0123Y ../grp-002` ### Create Group : `mkdir` -Creates a group consists of a maximum of five students +Creates a group consists of students Format: `mkdir [groupId]` -Acceptable values for each parameter: +#### Acceptable values for each parameter: + groupId: - groupId must be a non-empty string starting with grp- -Output if command fails +#### Output if command fails -- pop up message indicates error when creating new group +- Pop up message indicating either: + - Invalid command format + - Invalid groupId format -Output if command succeeds +#### Output if command succeeds -- pop up message indicates group with specific groupId was created successfully. +- Pop up message indicating a group with specific groupId was created successfully -Examples: -`mkdir grp-1` +#### Examples: -- This command will create a group with groupId which is a string called 1 and only consists the creator at that instance of creating the group +- When user is at the root directory `~` and keys in the following command, a group with groupId called grp-001 will be created + - `mkdir grp-001` -------------------------------------------------------------------------------------------------------------------- @@ -316,37 +329,63 @@ Format `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME --al - `deadline ~/grp-001 --desc Assignment 1 --datetime 2023-10-11 23:59 --all allStu` -### Mark/Unmark tasks as completed: `mark` +### Mark tasks as completed: `mark` -Marks specific tasks as done for each student/tutorial group +Marks a specific task as done for a student -Format: `mark -d [task] -level [student/group] -target [StudentID/groupId] ` +Format: `mark TASKINDEX` -Acceptable parameter should be: -task: +#### Acceptable parameter should be: -- must be a valid non empty String +taskIndex: -student: +- must be a valid index starts from 1 + +#### Output if command fails + +- Pop up message indicating either: + - Invalid command format + - Invalid task index + - The display panel is not showing task list -- String should be "student" or "group" +#### Output if command succeeds -StudentID: +- Pop up message saying mark is done successfully as well as specific task that is marked -- must be a valid non empty String starting with +#### Examples: -Output if command fails +- When user is at the group directory `~/grp-001` and keys in the following command, the task list of a student with specified path `~/grp-001/0123Y` will be shown after entering the command `cat 0123Y`. Then, user can mark task by specifying the task index: + - `cat 0123Y` + - `mark 1` -- pop up message saying mark is not done as well as specific task that is unchanged +### Unmark completed task: unmark` -Output if command succeeds +Unmarks specific tasks by a student -- pop up message saying mark is done successfully as well as specific task that is marked +Format: `unmark TASKINDEX` -Examples: -`mark -d Assignment 1 -level student -target 0123Y` +#### Acceptable parameter should be: + +taskIndex: + +- must be a valid index starts from 1 + +#### Output if command fails + +- Pop up message indicating either: + - Invalid command format + - Invalid task index + - The display panel is not showing task list + +#### Output if command succeeds + +- Pop up message saying unmark is done successfully as well as specific task that is unmarked + +#### Examples: -- This command will mark 0123Y's Assignment 1 as done +- When user is at the group directory `~/grp-001` and keys in the following command, the task list of a student with specified path `~/grp-001/0123Y` will be shown after entering the command `cat 0123Y`. Then, user can unmark task by specifying the task index: + - `cat 0123Y` + - `unmark 1` ### Search for Tasks: `find` @@ -421,16 +460,16 @@ _Details coming soon ..._ ## Command summary | Action | Format, Examples | -| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Help** | `help` | | **List** | `ls` | | **Clear** | `clear` | | **Exit** | `exit` | -| **Add** | `touch student -n [name] -id [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | -| **Create Group** | `mkdir [groupId]`
e.g., `mkdir grp-1` | -| **Delete** | `rm [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | -| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]`
e.g., `todo -desc ps1 -level student -target 0123Y` | +| **Add** | `touch student -n [name] -id [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | +| **Create Group** | `mkdir [groupId]`
e.g., `mkdir grp-001` | +| **Delete** | `rm [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | +| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]`
e.g., `todo -desc ps1 -level student -target 0123Y` | | **Create Deadline** | `deadline -desc [task] -level [student/group] -target [StudentID/groupId/tutorialId] -byDate[dd/MM/yyyy]`
e.g., `deadline -d grade proposal 1 -level group -target tut-1 -byDate 20/10/2023` | -| **Mark** | `mark -d [task] -level [student/group] -target [StudentID/groupId]`
e.g.,`mark -d Assignment 1 -level student -target 0123Y` | -| **Mark** | `unmark -d [task] -level [student/group] -target [StudentID/groupId]`
e.g.,`unmark -d Assignment 1 -level student -target 0123Y` | +| **Mark** | `mark [TASKINDEX]`
e.g.,`mark 1` | +| **Mark** | `unmark [TASKINDEX]`
e.g.,`unmark 2` | | **Find** | `find [task]`
e.g., `find grade proposal` | From 8b7995ca4a1a926d2f2b07753d1f1044d8abc797 Mon Sep 17 00:00:00 2001 From: NgChunMan Date: Thu, 26 Oct 2023 23:13:28 +0800 Subject: [PATCH 2/4] Update user guide --- docs/UserGuide.md | 103 +++++++++++++++++++++------------------------- 1 file changed, 46 insertions(+), 57 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index cbd85902c47..2513e49c6a5 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -114,12 +114,6 @@ Acceptable values for each parameter: - must be valid path -`SPECIFIED_STUDENT_PATH`: -- must be valid path - -`SPECIFIED_DESTINATION_PATH`: -- must be valid path - `NAME`: - must be a non-empty string @@ -143,13 +137,10 @@ Acceptable values for each parameter: # General Commands -### Viewing help : `help` (//TODO Update) +### Viewing help : `help` Shows a message explaning how to access the help page. -// TODO Update -![help message](images/helpMessage.png) - Format: `help` ### Listing all users : `ls` @@ -200,13 +191,13 @@ Specified path: #### Output if command fails: -- Pop up message indicating either: +- Displays message indicating either: - Invalid command format - Invalid path #### Output if command succeeds: -- Pop up message indicating successful creation together with information of created student +- Displays message indicating successful creation together with information of created student #### To note: @@ -237,13 +228,13 @@ Specified path: #### Output if command fails: -- Pop up message indicating either: +- Displays message indicating either: - Invalid command format - No such target to delete #### Output if command succeeds -- Pop up message indicating target successfully removed +- Displays message indicating target successfully removed #### Examples: @@ -258,62 +249,60 @@ Specified path: Moves student from one group to another group -Format: `mv SPECIFIED_STUDENT_PATH SPECIFIED_DESTINATION_PATH` +Format: `mv SPECIFIED_PATH_TO_STUDENT SPECIFIED_PATH_TO_GROUP` #### Acceptable values for each parameter: -Specified student path: +SPECIFIED_PATH_TO_STUDENT: - must be a valid path to a student that user wants to move -Specified destination path: +SPECIFIED_PATH_TO_GROUP: - must be a valid path to a group that user wants to move the student to #### Output if command fails -- Pop up message indicating either: +- Displays message indicating either: - Invalid command format - No such student to move - Invalid destination path #### Output if command succeeds -- Pop up message indicating successfully moving student from one group to another group +- Displays message indicating successfully moving student from one group to another group #### Examples: - When user is at the root directory `~` and keys in the following command, student with specified path `~/grp-001/0123Y` will be moved from grp-001 to grp-002: - - `mv grp-001/0123Y grp-002` + - `mv grp-001/0123Y grp-002` - When user is at the group directory `~/grp-001` and keys in the following command, student with specified path `~/grp-001/0123Y` will be moved from grp-001 to grp-002: - - `mv 0123Y ../grp-002` + - `mv 0123Y ../grp-002` ### Create Group : `mkdir` Creates a group consists of students -Format: `mkdir [groupId]` +Format: `mkdir PATH_TO_THE_GROUP` #### Acceptable values for each parameter: -groupId: +PATH_TO_THE_GROUP: -- groupId must be a non-empty string starting with grp- +- must be a valid path to a group #### Output if command fails -- Pop up message indicating either: +- Displays message indicating either: - Invalid command format - - Invalid groupId format + - Invalid path to a group #### Output if command succeeds -- Pop up message indicating a group with specific groupId was created successfully +- Displays message indicating a group was created successfully #### Examples: -- This command will create a group with groupId which is a string called 1 and only consists the creator at that - instance of creating the group - When user is at the root directory `~` and keys in the following command, a group with groupId called grp-001 will be created - `mkdir grp-001` @@ -333,13 +322,13 @@ Format: `todo SPECIFIED_PATH --desc DESCRIPTION --all CATERGORY` #### Output if command fails: -- Pop up message indicating either: +- Displays message indicating either: - Invalid command format - Invalid path #### Output if command succeeds -- Pop up message indicating todo task created successfully. +- Displays message indicating todo task created successfully. #### Examples: @@ -366,13 +355,13 @@ Format `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME --al #### Output if command fails: -- Pop up message indicating either: +- Displays message indicating either: - Invalid command format - Invalid path #### Output if command succeeds -- Pop up message indicating deadline task created successfully. +- Displays message indicating deadline task created successfully. #### Examples: @@ -400,14 +389,14 @@ taskIndex: #### Output if command fails -- Pop up message indicating either: +- Displays message indicating either: - Invalid command format - Invalid task index - The display panel is not showing task list #### Output if command succeeds -- Pop up message saying mark is done successfully as well as specific task that is marked +- Displays message saying mark is done successfully as well as specific task that is marked #### Examples: @@ -415,7 +404,7 @@ taskIndex: - `cat 0123Y` - `mark 1` -### Unmark completed task: unmark` +### Unmark completed task: `unmark` Unmarks specific tasks by a student @@ -429,14 +418,14 @@ taskIndex: #### Output if command fails -- Pop up message indicating either: +- Displays message indicating either: - Invalid command format - Invalid task index - The display panel is not showing task list #### Output if command succeeds -- Pop up message saying unmark is done successfully as well as specific task that is unmarked +- Displays message saying unmark is done successfully as well as specific task that is unmarked #### Examples: @@ -523,24 +512,24 @@ the data of your previous ProfBook home folder. ## Command summary -| Action | Format, Examples | -|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Action | Format, Examples | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Help** | `help` | -| **List** | `ls` | -| **Clear** | `clear` | -| **Exit** | `exit` | -| **Add** | `touch student -n [name] -id [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | -| **Create Group** | `mkdir [groupId]`
e.g., `mkdir grp-1` | -| **Delete** | `rm [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | -| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]`
e.g., `todo -desc ps1 -level student -target 0123Y` | -| **Add** | `touch student -n [name] -id [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | -| **Create Group** | `mkdir [groupId]`
e.g., `mkdir grp-001` | -| **Delete** | `rm [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | -| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]`
e.g., `todo -desc ps1 -level student -target 0123Y` | +| **Help** | `help` | +| **List** | `ls` | +| **Clear** | `clear` | +| **Exit** | `exit` | +| **Add** | `touch student -n [name] -id [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | +| **Create Group** | `mkdir PATH_TO_THE_GROUP`
e.g., `mkdir grp-1` | +| **Delete** | `rm [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | +| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]`
e.g., `todo -desc ps1 -level student -target 0123Y` | +| **Add** | `touch student -n [name] -id [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | +| **Create Group** | `mkdir [groupId]`
e.g., `mkdir grp-001` | +| **Delete** | `rm [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | +| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]`
e.g., `todo -desc ps1 -level student -target 0123Y` | | **Create Deadline** | `deadline -desc [task] -level [student/group] -target [StudentID/groupId/tutorialId] -byDate[dd/MM/yyyy]`
e.g., `deadline -d grade proposal 1 -level group -target tut-1 -byDate 20/10/2023` | -| **Mark** | `mark -d [task] -level [student/group] -target [StudentID/groupId]`
e.g.,`mark -d Assignment 1 -level student -target 0123Y` | -| **Mark** | `unmark -d [task] -level [student/group] -target [StudentID/groupId]`
e.g.,`unmark -d Assignment 1 -level student -target 0123Y` | -| **Mark** | `mark [TASKINDEX]`
e.g.,`mark 1` | -| **Mark** | `unmark [TASKINDEX]`
e.g.,`unmark 2` | -| **Find** | `find [task]`
e.g., `find grade proposal` | +| **Mark** | `mark -d [task] -level [student/group] -target [StudentID/groupId]`
e.g.,`mark -d Assignment 1 -level student -target 0123Y` | +| **Mark** | `unmark -d [task] -level [student/group] -target [StudentID/groupId]`
e.g.,`unmark -d Assignment 1 -level student -target 0123Y` | +| **Mark** | `mark TASKINDEX`
e.g.,`mark 1` | +| **Unmark** | `unmark TASKINDEX`
e.g.,`unmark 2` | +| **Find** | `find [task]`
e.g., `find grade proposal` | From 6050e486a3ab8824f7a96de1b51bbda024ee960d Mon Sep 17 00:00:00 2001 From: NgChunMan Date: Fri, 27 Oct 2023 01:44:10 +0800 Subject: [PATCH 3/4] Update user guide --- docs/UserGuide.md | 68 +++++++++++++++++++++++------------------------ 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 2513e49c6a5..3c410022819 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -130,7 +130,7 @@ Acceptable values for each parameter: - must be a non-empty string -`TASKINDEX`: +`TASK_INDEX`: - must be a valid index starts from 1 -------------------------------------------------------------------------------------------------------------------- @@ -249,17 +249,17 @@ Specified path: Moves student from one group to another group -Format: `mv SPECIFIED_PATH_TO_STUDENT SPECIFIED_PATH_TO_GROUP` +Format: `mv SPECIFIED_PATH SPECIFIED_PATH` #### Acceptable values for each parameter: -SPECIFIED_PATH_TO_STUDENT: +SPECIFIED_PATH: -- must be a valid path to a student that user wants to move +- must be a valid path to a student -SPECIFIED_PATH_TO_GROUP: +SPECIFIED_PATH: -- must be a valid path to a group that user wants to move the student to +- must be a valid path to a group #### Output if command fails @@ -270,7 +270,7 @@ SPECIFIED_PATH_TO_GROUP: #### Output if command succeeds -- Displays message indicating successfully moving student from one group to another group +- Displays message to indicate the successful transfer of a student from one group to another group #### Examples: - When user is at the root directory `~` and keys in the following command, student with specified path `~/grp-001/0123Y` will be moved from grp-001 to grp-002: @@ -377,9 +377,9 @@ Format `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME --al ### Mark tasks as completed: `mark` -Marks a specific task as done for a student +Marks the specified task as done for the student -Format: `mark TASKINDEX` +Format: `mark TASK_INDEX` #### Acceptable parameter should be: @@ -396,7 +396,7 @@ taskIndex: #### Output if command succeeds -- Displays message saying mark is done successfully as well as specific task that is marked +- Displays message indicating mark is done successfully as well as specific task that is marked #### Examples: @@ -406,9 +406,9 @@ taskIndex: ### Unmark completed task: `unmark` -Unmarks specific tasks by a student +Unmarks the specified task for the student -Format: `unmark TASKINDEX` +Format: `unmark TASK_INDEX` #### Acceptable parameter should be: @@ -425,7 +425,7 @@ taskIndex: #### Output if command succeeds -- Displays message saying unmark is done successfully as well as specific task that is unmarked +- Displays message indicating unmark is done successfully as well as specific task that is unmarked #### Examples: @@ -512,24 +512,24 @@ the data of your previous ProfBook home folder. ## Command summary -| Action | Format, Examples | -|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Help** | `help` | -| **List** | `ls` | -| **Clear** | `clear` | -| **Exit** | `exit` | -| **Add** | `touch student -n [name] -id [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | -| **Create Group** | `mkdir PATH_TO_THE_GROUP`
e.g., `mkdir grp-1` | -| **Delete** | `rm [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | -| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]`
e.g., `todo -desc ps1 -level student -target 0123Y` | -| **Add** | `touch student -n [name] -id [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | -| **Create Group** | `mkdir [groupId]`
e.g., `mkdir grp-001` | -| **Delete** | `rm [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | -| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]`
e.g., `todo -desc ps1 -level student -target 0123Y` | -| **Create Deadline** | `deadline -desc [task] -level [student/group] -target [StudentID/groupId/tutorialId] -byDate[dd/MM/yyyy]`
e.g., `deadline -d grade proposal 1 -level group -target tut-1 -byDate 20/10/2023` | -| **Mark** | `mark -d [task] -level [student/group] -target [StudentID/groupId]`
e.g.,`mark -d Assignment 1 -level student -target 0123Y` | -| **Mark** | `unmark -d [task] -level [student/group] -target [StudentID/groupId]`
e.g.,`unmark -d Assignment 1 -level student -target 0123Y` | -| **Mark** | `mark TASKINDEX`
e.g.,`mark 1` | -| **Unmark** | `unmark TASKINDEX`
e.g.,`unmark 2` | -| **Find** | `find [task]`
e.g., `find grade proposal` | +| Action | Format, Examples | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Help** | `help` | +| **List** | `ls` | +| **Clear** | `clear` | +| **Exit** | `exit` | +| **Add** | `touch student -n [name] -id [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | +| **Create Group** | `mkdir PATH_TO_THE_GROUP`
e.g., `mkdir grp-1` | +| **Delete** | `rm [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | +| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]`
e.g., `todo -desc ps1 -level student -target 0123Y` | +| **Add** | `touch student -n [name] -id [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | +| **Create Group** | `mkdir [groupId]`
e.g., `mkdir grp-001` | +| **Delete** | `rm [StudentId]`
e.g., `touch student -n Gary -id 1234Y` | +| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]`
e.g., `todo -desc ps1 -level student -target 0123Y` | +| **Create Deadline** | `deadline -desc [task] -level [student/group] -target [StudentID/groupId/tutorialId] -byDate[dd/MM/yyyy]`
e.g., `deadline -d grade proposal 1 -level group -target tut-1 -byDate 20/10/2023` | +| **Mark** | `mark -d [task] -level [student/group] -target [StudentID/groupId]`
e.g.,`mark -d Assignment 1 -level student -target 0123Y` | +| **Mark** | `unmark -d [task] -level [student/group] -target [StudentID/groupId]`
e.g.,`unmark -d Assignment 1 -level student -target 0123Y` | +| **Mark** | `mark TASK_INDEX`
e.g.,`mark 1` | +| **Unmark** | `unmark TASK_INDEX`
e.g.,`unmark 2` | +| **Find** | `find [task]`
e.g., `find grade proposal` | From cfb4fba1c8ca491677e69e17776f280601b8fc4a Mon Sep 17 00:00:00 2001 From: NgChunMan Date: Fri, 27 Oct 2023 10:08:51 +0800 Subject: [PATCH 4/4] Update user guide --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3c410022819..811cc3303c2 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -412,7 +412,7 @@ Format: `unmark TASK_INDEX` #### Acceptable parameter should be: -taskIndex: +task index: - must be a valid index starts from 1