Skip to content

Commit

Permalink
Merge pull request #252 from PearlynnT/ugdg-edit
Browse files Browse the repository at this point in the history
Edit Doc
  • Loading branch information
PearlynnT authored Nov 14, 2023
2 parents 53dc11a + 68cb1fd commit 267e9e8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -622,22 +622,22 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
2. Student provides the group number.
3. StudentConnect retrieves the group by the given group number.
4. If the group exists, StudentConnect displays the group in the group panel.
5. StudentConnect displays the listed tasks along with a success message.
5. StudentConnect displays the listed tasks along with a success message.<br>
Use case ends.

**Extensions:**

* 2a. The student enters a non-existent group number.
* 2a1. StudentConnect shows an error message: "Group with the provided group number not found."
* 2a1. StudentConnect shows an error message: "Group with the provided group number not found."<br>
Use case ends.

* 2b. The student enters an invalid group number.
* 2a1. StudentConnect shows an error message: "Invalid command format!"
* 2b1. StudentConnect shows an error message: "Invalid command format!"<br>
Use case ends.

* 4a. The specified group exists but has no tasks initialised.
* 4a1. StudentConnect initialises the tasks for the group.
* 4a2. StudentConnect displays the newly initialised tasks along with a success message.
* 4a2. StudentConnect displays the newly initialised tasks along with a success message.<br>
Use case resumes at step 5.

* 4b. Task initialisation fails due to a system error.
Expand All @@ -658,11 +658,11 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
**Extensions:**

* 2a. The specified group does not exist.
* 2a1. StudentConnect shows an error message: "Group with the provided group number not found."
* 2a1. StudentConnect shows an error message: "Group with the provided group number not found."<br>
Use case ends.

* 2b. The specified task index is invalid.
* 2b1. StudentConnect shows an error message: "Invalid task index. Task not found."
* 2b1. StudentConnect shows an error message: "Invalid task index. Task not found."<br>
Use case ends.

**Use Case: UC18 - Mark Task as Not Done**
Expand All @@ -679,11 +679,11 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
**Extensions:**

* 2a. The specified group does not exist.
* 2a1. StudentConnect shows an error message: "Group with the provided group number not found."
* 2a1. StudentConnect shows an error message: "Group with the provided group number not found."<br>
Use case ends.

* 2b. The specified task index is invalid.
* 2b1. StudentConnect shows an error message: "Invalid task index. Task not found."
* 2b1. StudentConnect shows an error message: "Invalid task index. Task not found."<br>
Use case ends.

**Use Case: UC19 - Get help**
Expand Down
2 changes: 1 addition & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ Creates a new empty group with the given tutorial number. The group number is au

![Sample result for create](images/create.png)

#### Expected Output(Failure):
#### Expected Output (Failure):
* Case: Invalid command format, e.g. `create`, `create 02`, etc.<br>
Message: `Invalid command format!`<br>
`create: Creates a new empty group.`<br>
Expand Down

0 comments on commit 267e9e8

Please sign in to comment.