Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix bugs in UG and DG, add find sequence diagram in DG #284

Merged
merged 4 commits into from
Nov 11, 2024
Merged

Fix bugs in UG and DG, add find sequence diagram in DG #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3b810bd
Fix bugs in UG and DG
yyihaoc Nov 10, 2024
337a7ee
Add period in UG
yyihaoc Nov 10, 2024
934c92d
Add sequence diagram for find in DG
yyihaoc Nov 11, 2024
33f8316
Fix whitespaces in UG, DG
yyihaoc Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,8 +203,6 @@ The following sequence diagram shows how a mark operation goes through the `Logi

</div>

Similarly, how an undo operation goes through the `Model` component is shown below:

![MarkAttendanceSequenceDiagram-Model](images/MarkAttendanceSequenceDiagram-Model.png)

The `unmark` command does the opposite with the similar flow between `Logic` and `Model` component.
Expand All @@ -214,6 +212,16 @@ The following activity diagram summarizes what happens when a user executes a ne

<img src="images/CommitActivityDiagram.png" width="250" />

### Find feature

#### Implementation

The `find` command relies on the various `Predicate` classes, each of which encapsulates specific criteria to determine whether a contact matches the search conditions. These `Predicate` classes enable flexible and modular search logic, allowing the `find` command to filter contacts based on attributes such as `Name`, `Telegram`, `Role`, `FavouriteStatus`.

The following sequence diagram shows how a `find f/` command goes through both `Logic` component and interacts with `Model`

![FindSequenceDiagram](images/FindSequenceDiagram.png)

### Switch Profile Feature

The `switch` command allows users to manage separate profiles within the application, each storing independent data in an isolated session. This feature enables users to work on different datasets without interference, as if each profile represented a unique instance of the application.
Expand Down Expand Up @@ -312,7 +320,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
| `*` | user | set privacy levels for each contact's information | protect sensitive details |
| `*` | user | see a profile picture for each contact | recall the person from the picture |



### Use cases

Expand Down
Loading