[CS2113-W14-3] Future Academic Planner (FAP) #58
Conversation
…yao-rating-system Add rating system for books. Rate books and list books based on good …
Fix add module out of CEGModules
…into update_UG_and_bugs * 'master' of https://github.com/AY2324S2-CS2113T-W14-3/tp: fix bug
Remove "CU" grade functionality
Update UserGuide.md
…into update_UG_and_bugs * 'master' of https://github.com/AY2324S2-CS2113T-W14-3/tp: Update UserGuide.md Remove "CS" grade argument from UserGuide Remove "CU" grade from occurence Update UserGuide.md Update UserGuide.md # Conflicts: # docs/UserGuide.md
Update UG and fix bugs for desiredgpa command
Refactor FAP and Storage to improve code quality
| `GPA = SUM(Course Grade Point * Course Units) / SUM(Course Units Counted Towards GPA)` | ||
|
|
||
| Below is the sequence diagram for `ViewGpaCommand`. | ||
|  |
There was a problem hiding this comment.
Overall good sequence diagram drawn.
For the ViewGpaCommand sequence diagram:
- Can write what output is returned to the user
- Is the log message and GpaNullException supposed to be returned to ModuleList? (No need to write them for the return line)
docs/DeveloperGuide.md
Outdated
| | Version | As a ... | I want to ... | So that I can ... | | ||
| |---------|----------|---------------------------|-------------------------------------------------------------| | ||
| | v1.0 | new user | see usage instructions | refer to them when I forget how to use the application | | ||
| | v2.0 | user | find a to-do item by name | locate a to-do without having to go through the entire list | |
docs/DeveloperGuide.md
Outdated
|
|
||
| ## Product scope | ||
|
|
||
| ### Target user profile | ||
|
|
||
| {Describe the target user profile} |
There was a problem hiding this comment.
Is the target user profile and value proposition updated?
docs/DeveloperGuide.md
Outdated
| System.out.println("Module MC: " + jsonManager.getModuleMC()); | ||
| } | ||
| ``` | ||
| 6. **Viewing modules left to graduate** |
There was a problem hiding this comment.
Is it possible to include sequence diagrams for each of the command class for visualisation?
docs/DeveloperGuide.md
Outdated
| System.out.println("Module MC: " + jsonManager.getModuleMC()); | ||
| } | ||
| ``` | ||
| 6. **Viewing modules left to graduate** |
There was a problem hiding this comment.
Should there be a C/E beside ur class names? (Should remove the C and E logos)
Are the symbols appropriate? (Should remove the green circles and red squares with + and - for public and private attributes and methods) -> applies to all diagrams.
docs/diagrams/ViewGpaCommand.puml
Outdated
| Loop For each Module | ||
| ModuleList -> Module: | ||
| activate Module | ||
| Module -> Module: Check if grade is countable |
| Parser --> Command : returns | ||
| FAP ..> Command : uses | ||
|
|
||
| @enduml |
There was a problem hiding this comment.
The circle representing the class does not comply with the standard. Should off it in plantUML.
docs/diagrams/FAP.puml
Outdated
| @@ -0,0 +1,34 @@ | |||
| @startuml | |||
| class FAP { | |||
| - static moduleList: ModuleList | |||
There was a problem hiding this comment.
Use "+" and "-" to represent public and private attributes, not squares and cirlces generated by plantUML.
| GpaNullException --> ModuleList: GpaNullException | ||
| deactivate GpaNullException | ||
| ModuleList --> ViewGpaCommand: GpaNullException | ||
| else Calculate GPA |
There was a problem hiding this comment.
The square bracket here should be the condition (eg. else)?
There was a problem hiding this comment.
Great job overall, the developer guide was clear and easy to read. However, you can consider giving a brief description about what your application does at the beginning to give clarity on the classes that you introduce later. Also you can consider removing some of the default settings of your plantuml class and sequence diagrams.
docs/DeveloperGuide.md
Outdated
| ``` | ||
| #### UML Diagram | ||
|
|
||
|  |
There was a problem hiding this comment.
When defining classes in the class diagram, you can consider using '-' and + should be used to denote private and public attributes and methods respectively instead of using the default settings of plantUML.
docs/DeveloperGuide.md
Outdated
|
|
||
| ```java | ||
| JsonManager jsonManager = new JsonManager(); | ||
| if (jsonManager.moduleExist("CS1010")) { |
There was a problem hiding this comment.
You can consider using try catch when checking in the module exists
| `GPA = SUM(Course Grade Point * Course Units) / SUM(Course Units Counted Towards GPA)` | ||
|
|
||
| Below is the sequence diagram for `ViewGpaCommand`. | ||
|  |
There was a problem hiding this comment.
Is it possible to crop out the the classes that appear at the bottom of the sequence diagram?
docs/DeveloperGuide.md
Outdated
| us **safety in the arguments** that passes through to the commands via the userInput. | ||
| <br /> | ||
| <br /> | ||
| **Developer usage FAP: Parser & CommandMetadata class as of v2.0**: **How to create a new command** |
There was a problem hiding this comment.
Great job in going the extra mile in describing the way to maintaining and adding to the codebase for future developers!
docs/DeveloperGuide.md
Outdated
| ### UML Diagram | ||
|
|
||
| A simplified UML diagram for the Storage class and its interaction with the Module, User, and exception classes is shown below: | ||
| -  | ||
|
|
||
| ### Integration with FAP |
There was a problem hiding this comment.
You can consider editing this part of the developer guide as the "###" used here is not recognised as the "header"
add javaDoc and PPP
Add more page breaks
…into deliverables_update * 'master' of https://github.com/AY2324S2-CS2113T-W14-3/tp: adhere to gradle checkstyle add javaDoc and PPP Add picture Update PPP and AboutUs
add image to about us
* 'master' of https://github.com/AY2324S2-CS2113T-W14-3/tp: (63 commits) add image to about us Amended aboutus page Test table for aboutus adhere to gradle checkstyle Add more page breaks add javaDoc and PPP Test line break Add picture Update PPP and AboutUs Amendments do DG Update DG and PPP Modify activation line for parser sequence diagram Update DG target user and glossary Update diagrams Add photo and update AboutUs and PPP Include proper formatting for PPP Resolve merge conflict Add more Javadocs Include contributions to PPP Update PPP and AboutUs ...
Update sxfoo PPP
…into PPP * 'master' of https://github.com/AY2324S2-CS2113T-W14-3/tp: Update sxfoo PPP
WenWu PPP update and synced root README to docs README
Update Ui photo in readme
Amend root README
Update PPP for Thaw and Dexter
Add minor changes to PPP
Future Academic Planner (FAP) is a robust academic management software designed to help streamline NUS Computer Engineering (CEG) student’s academic journey at NUS. If you can type fast, FAP can get your module planning done faster than your traditional GUI app.