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.

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

Amended wrong diagrams in the DG #293

Merged
merged 1 commit into from
Nov 8, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ Display | Name | Github Profile | Portfolio
---|:---:|:---:|:---:
![](./images/Profile/Jerrold.JPG) | Lam Tian Yu Jerrold | [jerroldlam](https://github.com/jerroldlam "Github User Profile") | [Portfolio](team/jerroldlam.md)
![](https://avatars3.githubusercontent.com/u/56764814?s=100) | Khenus Tan Jia Liang | [Khenus](https://github.com/Khenus "Github User Profile") | [Portfolio](team/khenus.md)
![](./images/Profile/Harry.JPG) | Harry Lee Chein Pong | [harryleecp](https://github.com/harryleecp "Github User Profile") | [Portfolio](team/harryleecp.md)
![](./images/Profile/Harry.jpg) | Harry Lee Chein Pong | [harryleecp](https://github.com/harryleecp "Github User Profile") | [Portfolio](team/harryleecp.md)
![](https://avatars3.githubusercontent.com/u/57383789?s=100) | Ju Zihao | [JuZihao](https://github.com/JuZihao "Github User Profile") | [Portfolio](team/juzihao.md)
![](https://avatars3.githubusercontent.com/u/49282734?s=400) | Vanessa Kang Rui | [Vanessa-Kang](https://github.com/vanessa-kang "Github User Profile") | [Portfolio](team/vanessa-kang.md)
20 changes: 13 additions & 7 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ The [*sequence diagram*](#sequence-diagram) below shows how different packages a
<div style="text-align:center">
<img src="./images/DeveloperGuide/Details_architecture.png" alt="Details architecture diagram of PlanNUS"/>
</div>
Note that the above diagram is only intended for showing the connections to PlanNus main class rather than between individual classes.

<br>

#### 3.5.1. Global Component
Expand All @@ -135,7 +137,7 @@ Classes used by multiple components are part of the `global` component of PlanNU
</div>


The `Storage` component is responsible for the loading and saving of information from text files.
The `Storage` component is responsible for the loading and saving of information from text files which can happen in two types of scenarios. The first type would be through the use of commands specified in the diagram which can be found in the _Academic Planner_ app. Alternatively, the user may also exit from the program using the commands within the application itself. This is to prevent loss of data when the user terminates the program by closing the command prompt or using the _ctrl-c_ command.

**API** : `src.main.java.seedu.duke.storage`

Expand Down Expand Up @@ -521,12 +523,14 @@ __Extensions__

- 1a1. PlanNUS shows a _missing parameter_ error message.


Use case ends.

- 1b. User enters a module code that is not offered by NUS.

- 1b1. PlanNUS shows an _invalid module code_ error message.


Use case ends.

- 3a. User enters an invalid semester.
Expand Down Expand Up @@ -569,26 +573,27 @@ __Extensions__

- 1a1. PlanNUS shows a _missing parameter_ error message.


Use case ends.

- 1b. User enters a module code that is not offered by NUS.

- 1b1. PlanNUS shows an _invalid module code_ error message.

Use case ends.

- 1c. User enters a module code that is offered by NUS, but is not currently in the user's academic calendar.

- 1c1. PlanNUS shows a _module not in calendar_ error message.

Use case ends.

- 3a. User chooses a feature that is invalid.

- 3a1. PlanNUS shows an _invalid feature_ error message.

Use case ends.

- 5a. User enters an updated value that is invalid.

- 5a1. PlanNUS shows an _invalid value_ error message.
Expand All @@ -614,14 +619,15 @@ __Extensions__
- 1a. User did not specify a module code while removing a module.
- 1a1. PlanNUS shows a _missing parameter_ error message.


Use case ends.

- 1b. User enters a module code that is not offered by NUS.

- 1b1. PlanNUS shows an _invalid module code_ error message.

Use case ends.

- 1c. User enters a module code that is offered by NUS, but is not currently in the user's academic calendar.

- 1c1. PlanNUS shows a _module not in calendar_ error message.
Expand Down Expand Up @@ -782,7 +788,7 @@ __Extensions__
- 3a1. PlanNUS shows an _invalid CAP_ error message.

Use case ends.

- 5a. User provides a valid target CAP, but the target MCs is not valid.
- 5a1. PlanNUS shows an _invalid MCs_ error message.

Expand Down Expand Up @@ -859,7 +865,7 @@ __Extensions__
- 3b1. PlanNUS shows a _number out of bound_ error message.

Use case ends.

- 5a. User did not enter a valid module code.

- 5a1. PlanNUS shows an _invalid module_ error message.
Expand Down
Binary file modified docs/images/DeveloperGuide/Storage_architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/DeveloperGuide/editModuleCommand_sequence.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/DeveloperGuide/removeModuleCommand_sequence.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.