Skip to content

Commit

Permalink
Merge pull request #359
Browse files Browse the repository at this point in the history
Fix issues raised in PE-D
  • Loading branch information
KrashKart authored Nov 10, 2024
2 parents f51ea1e + bbc2581 commit 242cb8b
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 31 deletions.
29 changes: 6 additions & 23 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Given below is a quick overview of main components and how they interact with ea
**Main components of the architecture**

**`Main`** (consisting of classes [`Main`](https://github.com/AY2425S1-CS2103T-F14a-4/tp/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/AY2425S1-CS2103T-F14a-4/tp/tree/master/src/main/java/seedu/address/MainApp.java)) is in charge of the app launch and shut down.

* At app launch, it initializes the other components in the correct sequence, and connects them up with each other.
* At shut down, it shuts down the other components and invokes cleanup methods where necessary.

Expand Down Expand Up @@ -129,6 +130,7 @@ The structure is simple:
* They also contain their own respective error messages.

### Model component

**API** : [`Model.java`](https://github.com/AY2425S1-CS2103T-F14a-4/tp/tree/master/src/main/java/seedu/address/model/Model.java)

<puml src="diagrams/ModelClassDiagram.puml" width="450" />
Expand Down Expand Up @@ -385,10 +387,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli


* 1b. Contact to find does not exist.
* 1b1. CampusConnect shows error message.
* 1b2. User enters input again.

Steps 1b1-1b2 repeat until input format is valid.
* 1b1. CampusConnect shows empty contact list.

Use case ends.

Expand Down Expand Up @@ -454,16 +453,8 @@ before the command was executed.
Use case ends

**Extensions**
* 1a. Input format is invalid.
* 1a. No earlier data to revert.
* 1a1. CampusConnect shows error message.
* 1a2. User enters input again.

Steps 1a1-1a2 repeat until input format is valid.

Use case ends.

* 1b. No earlier data to revert.
* 1b1. CampusConnect shows error message.

Use cases ends.

Expand All @@ -478,16 +469,8 @@ before the command was executed.
Use case ends.

**Extensions:**
* 1a. Invalid Input Format:
* 1a1. CampusConnect displays an error message indicating the input format is invalid.
* 1a2. The user re-enters the input.

Steps 1a1-1a2 repeat until the input format is valid.

Use case ends.

* 1b. No More Commands to Redo:
* 1b1. CampusConnect displays an error message indicating that there are no more commands to redo.
* 1a. No More Commands to Redo:
* 1a1. CampusConnect displays an error message indicating that there are no more commands to redo.

Use case ends.

Expand Down
9 changes: 3 additions & 6 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ any traditional point-and-click management app.
1. Copy the file to the folder you want to use as the _home folder_ for your CampusConnect.

1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar CampusConnect.jar` command to run the application.<br>
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
![Ui](images/Ui.png)
A GUI similar to the below should appear in a few seconds. Note how the app does not contain any sample data.<br>
![EmptyUi](images/EmptyUi.png)

1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
Some example commands you can try:
Expand All @@ -38,7 +38,7 @@ any traditional point-and-click management app.

* `add n/John Doe p/98765432 e/johnd@example.com` : Adds a contact named `John Doe` with phone number `98765432` and email `johnd@example.com` to CampusConnect.

* `delete 3` : Deletes the 3rd contact shown in the current list.
* `delete 1` : Deletes the 1st contact shown in the current list.

* `clear` : Deletes all contacts.

Expand Down Expand Up @@ -222,9 +222,6 @@ Examples:
* `deltag 1 t/friend`
deletes the friend tag of the first person in the list.

Disallowed examples:
* `deltag 2 t/classmate t/neighbour` will not succeed as it tries to delete 2 tags at once.

### Categorizing a tag : `cattag`

Categorizes a tag under a defined category.
Expand Down
4 changes: 2 additions & 2 deletions docs/diagrams/BetterModelClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ UniqueTagList -[hidden]down- UniquePersonList
UniqueTagList -[hidden]down- UniquePersonList

UniqueTagList -right-> "*" Tag
UniquePersonList -right-> Person
UniquePersonList -right-> "*" Person

Person -up-> "*" Tag
Person *-up-> "*" Tag

Person *--> "1" Name
Person *--> "1" Phone
Expand Down
Binary file added docs/images/EmptyUi.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 242cb8b

Please sign in to comment.