Skip to content

Commit

Permalink
Merge pull request #320 from mingyuanc/291-final-edit-dg
Browse files Browse the repository at this point in the history
  • Loading branch information
@zannloo
zannloo authored Nov 13, 2023
2 parents d831ae2 + d1b4f29 commit 24f0ee9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 deletions.
28 changes: 16 additions & 12 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@ implementation of a component), as illustrated in the (partial) class diagram be

The sections below give more details of each component.

<div style="page-break-after: always;"></div>

### UI component

The **API** of this component is specified
Expand Down Expand Up @@ -472,7 +474,7 @@ The following methods of `ModelManager` and `ChildOperation<Student>` are used:
the validity and presence of the specified group.
2. `ChildOperation<Student>::addAllTasks` - To add the tasks to all student within a group, it also checks if it is a
duplicate task before adding.
3. `ChildOperation<Student>::checkIfAllChildrenHaveTask` - To check if all children within a group already has the task.
3. `ChildOperation<Student>::doAllStudentHaveTask` - To check if all children within a group already has the task.

It is important to note that for adding a task to a singular group/student, the operation class `TaskOperation` is used
instead, a sequence diagram illustrating this can be found in the `Model` component.
Expand All @@ -493,7 +495,7 @@ Given below is an example usage scenario on how an existing user can add Deadlin
4. This command would first
* check if the specified path is a valid and present group path. This is done via `AbsolutePath::isGroupDirectory` method.
* check if all students in the group already has the task. This is done
via `ChildOperation<Student>::checkIfAllChildrenHaveTask` method.
via `ChildOperation<Student>::doAllStudentHaveTask` method.
5. If all checks out, the command would create a new `Deadline` instance and add the deadline to all student that do not
already have the aforementioned task. This is done
through getting a `ChildOperation<Student>` class from the `Model::groupChildOperation` method. The tasks are then
Expand Down Expand Up @@ -770,19 +772,21 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
| `* * *` | New user | see usage instructions | refer to instructions when I forget how to use the App |
| `* * *` | New user | take advantage of existing Linux skills | be more efficient in using the application |
| `* * *` | New user | create deadlines for student | keep track of when assignments are due |
| `* * *` | New user | create todo task for student | keep track of which label they are at |
| `* * *` | New user | create todo task for student | keep track of their progress |
| `* * *` | New user | create deadline for a group | keep track of when group specific assignments are due |
| `* * *` | New user | create todo for a group | keep track of the progress of each group relative to others |
| `* * *` | New user | add time to a task | i can record when a task needs to be done |
| `* * *` | New user | add time to a task | I can record when a task needs to be done |
| `* * *` | New user | set alerts and notification | I can receive the notifications of the task |
| `* * *` | New user | add the profile picture of students | I can better remember them |
| `* * *` | New user | add the matriculation number of students | I can update their grade based on the matriculation number |
| `* * *` | New user | add the matriculation number of students | I can track their tasks based on their matriculation number |
| `* * *` | New user | create student profile | manage information of a specific student |
| `* * *` | New user | delete a student | remove students that I no longer need |
| `* * *` | New user | delete a student | remove students that I no longer need to keep track of |
| `* * *` | New user | delete a group | remove groups that I no longer need to keep track of |
| `* * *` | New user | delete a task | remove tasks that I no longer need to keep track of |
| `* * *` | New user | create group | manage information of a specific group |
| `* * *` | Experienced user | mark task done for every student in a group | I do not need to mark each task manually |
| `* * *` | Experienced user | add tasks for every student in the book | I do not need to add tasks manually |
| `* * *` | Experienced user | add tasks for every student in a group | I do not need to add tasks manually |
| `* * ` | New user | add the profile picture of students | I can better remember them |
| `* * ` | New user | create tutorial slot | manage information fo a specific tutorial slot |
| `* * ` | New user | create deadline for a tutorial group | keep track of when tutorial specific assignments are due |
| `* * ` | New user | create todo tasks for a tutorial group | keep track of the progress of each tutorial group relative to others |
Expand Down Expand Up @@ -1032,7 +1036,7 @@ otherwise)

**Extensions**

* 1a. User inputs command while not in tasklist display.
* 1a. User inputs command while not in task list display.

* 1a1. ProfBook shows an error message.

Expand Down Expand Up @@ -1101,7 +1105,7 @@ otherwise)
**MSS**

1. User requests to create a ToDo task.
2. ProfBook creates the Task under specified path/current path.
2. ProfBook creates the task under specified path/current path.

Use case ends.

Expand Down Expand Up @@ -1142,7 +1146,7 @@ otherwise)
**MSS**

1. User requests to create a Deadline task.
2. ProfBook creates the Task under specified path/current path.
2. ProfBook creates the task under specified path/current path.

Use case ends.

Expand Down Expand Up @@ -1195,7 +1199,7 @@ otherwise)

**Extensions**

* 1a. User inputs command while not in tasklist display.
* 1a. User inputs command while not in task list display.
* 1a1. ProfBook shows an error message.

Use case resumes at step 1.
Expand All @@ -1216,7 +1220,7 @@ otherwise)

**Extensions**

* 1a. User inputs command while not in tasklist display.
* 1a. User inputs command while not in task list display.
* 1a1. ProfBook shows an error message.

Use case resumes at step 1.
Expand Down
2 changes: 1 addition & 1 deletion docs/team/mingyuanc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Given below are my contributions to the project.
* Adds another layer of safety by checking the validity and presence of the directory before performing modification.
* Highlights:
* Deep-understanding of what is required by `Command` class was required when designing this class.
* **Introduced `ChildrenAndTaskListManager` Class**
* **Introduced `ChildAndTaskListManager` Class**
* Wrapper class that manages the operations required for both TaskList and Children.
* **Introduced `Student`, `Group`, `Root` Class**
* Encapsulates the required information to uniquely represent the respective objects.
Expand Down

0 comments on commit 24f0ee9

Please sign in to comment.