Skip to content

Commit

Permalink
Merge pull request #69 from mohamedsaf1/master
Browse files Browse the repository at this point in the history
Edit DevGuide
  • Loading branch information
autumn-sonata authored Oct 28, 2022
2 parents f4a03a9 + a074ed4 commit ebbc2fe
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,12 +165,11 @@ the `Logic` component as the other commands described above.

However, during execution, tasks commands may update the context of the current tasks of a team. To understand tasks better,
it should be understood that Tasks are an attribute of a Teams object, which is used to indicate if a tasks is done (also known as marked),
or not (also known as unmarked).
or not (also known as unmarked). Moreover, progress of each task can be tracked with specific levels (namely 25%, 50%, 75% and 100 %).

Below is the class diagram that illustrates the interactions between Logic and Model components, in relation to tasks.

The Sequence Diagram below shows the interaction between `Logic` and `Model` components when `execute("at ..")` is called.

[insert Sequence Diagram]
![Interactions Inside the Logic Component for the `cg ..` Command](images/TaskClassDiagram.png)

This way of implementation of maintains abstraction of details of the `Logic` component, in the `Model` component.

Expand Down
15 changes: 15 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,21 @@ Example:

This sets the status of the `Generate report` task in the `Accountants` team to Sep 13, 2022 at 10:20am UTC time.

### Set progress for tasks: `task progress`

Sets the progress level for each task that has been listed.

Format: `task progress i/<INDEX> <LEVEL>`

- Index indicates the index of the task in the list
- Level indicates the progress level, and can only be set to 25%, 50%, 75%, 100%

Example:
- `task progress 1 25%`

This sets the progress of the first task in the list as 25%


## FAQ

> How can I install `Java 11`?
Expand Down
Binary file added docs/images/TaskClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ebbc2fe

Please sign in to comment.