[CS2113T-F08-4] UniTracker #31

BlubberMonster · 2021-03-05T00:21:02Z

Our product is user-specific as it allows users to customize and personalize their own module information and deadlines to suit their needs. Our product allows users to organize their own daily schedules and keep track of their deadlines all on one platform.

Added Saving Functionality

s-t-e-f · 2021-03-31T02:24:23Z

docs/DeveloperGuide.md

+Returning to module information menu...
+  ```
+Given below is the sequence diagram for the feature:  
+![Diagram](diagrams/addNewReview.png)  


Maybe can change the format of objects to "name :Class1" or " :Class1"

s-t-e-f · 2021-03-31T02:33:26Z

docs/DeveloperGuide.md

+5) `Message` <br> Example: `Good job!`
+
+Given below is the sequence diagram for the feature:  
+![Diagram](diagrams/addNewTask.png)


Maybe can end the lifelines of ModuleInfo and Module objects after they have been deleted

s-t-e-f · 2021-03-31T02:42:47Z

docs/DeveloperGuide.md

+5) `Message` <br> Example: `Good job!`
+
+Given below is the sequence diagram for the feature:  
+![Diagram](diagrams/addNewTask.png)


To reduce clutter, maybe some of the activation bars and return arrows can be omitted

s-t-e-f · 2021-03-31T02:45:54Z

docs/DeveloperGuide.md

+Returning to module information menu...
+  ```
+Given below is the sequence diagram for the feature:  
+![Diagram](diagrams/addNewReview.png)  


Maybe can consider breaking this sequence diagram into smaller fragments using ref frames

jovanhuang

Overall, looks good! :)

jovanhuang · 2021-03-31T02:36:31Z

docs/DeveloperGuide.md

+Returning to module information menu...
+  ```
+Given below is the sequence diagram for the feature:  
+![Diagram](diagrams/addNewReview.png)  


Generally, quite a detailed sequence diagram. The logic flows correctly, from top to bottom.

It would be better if the "ModuleInfo" is ":ModuleInfo" instead. I see the same thing in other places.

jovanhuang · 2021-03-31T02:48:13Z

docs/DeveloperGuide.md

+5) `Message` <br> Example: `Good job!`
+
+Given below is the sequence diagram for the feature:  
+![Diagram](diagrams/addNewTask.png)


It would be good if the "printing error" methods are from the Logger instead of Ui class (same as the sequence diagram of addNewReview) for consistency. :)

jovanhuang · 2021-03-31T02:52:35Z

docs/DeveloperGuide.md

+### 4.05 Add Zoom Link
+
+Given below is the sequence diagram for the feature:  
+![Diagram](diagrams/addZoomLink.png)


It would be good if the methods being called have () behind it in the sequence diagram.

for Example: use printAndGetModule() instead of printAndGetModule. :)

jovanhuang · 2021-03-31T03:02:12Z

docs/DeveloperGuide.md

+This feature allows user to add user-defined module components and its related weightage for an
+existing module.
+
+![Diagram](diagrams/addComponent.png)  


In the sequence diagram of addComponent, it would be good if it is shown where "command" is used for after it was returned to Component. (or at least show that it is subsequently returned to ModuleInfo & Duke if "command" is used for other parts) :)

Add mc and grade (associated to module) to Module Storage.

…into nikhila-UserGuide

Nikhila user guide

…into hazel-TaskManager # Conflicts: # UniTracker Data/modules.txt # src/main/java/seedu/duke/ModuleInfo.java

updated storage system and fixed delete task bug

KimIdeas8

Overall, nice DG over there! 👏💐🎂🥳💃

KimIdeas8 · 2021-03-31T18:54:24Z

docs/DeveloperGuide.md

+- `Storage`: Write data to, and loads data to hard disk
+
+![Diagram](diagrams/MainArchitecture.png)
+


should ui be pointing to the other classes?

for a class name like 'helpGraduation', a suggestion can be to write in CamelCase.

KimIdeas8 · 2021-03-31T19:11:06Z

docs/DeveloperGuide.md

+user has to input a valid format for the __date__ and __time__ field (refer to section 3.3.1 of User
+Guide or the example above), and our application will convert it to a more readable format for the
+user. Using the example above,
+


It's nice to have numberings to improve formatting here :))

KimIdeas8 · 2021-03-31T19:14:09Z

docs/DeveloperGuide.md

+tasks in the `ArrayList` for the task type they chose will then be printed out, and the user has to
+input the index of the task they want to delete. The task they select will then be deleted from
+the `ArrayList`.
+


Same for improving formatting :))

KimIdeas8 · 2021-03-31T19:25:35Z

docs/DeveloperGuide.md

+3) `Date` <br> Example: `2021-03-21`
+4) `Time` <br> Example: `23:59`
+5) `Message` <br> Example: `Good job!`
+


cool to add <br> after each example so the next argument can fall on the next line :))

updated user docs with task manager features

… set total number of MCs taken to range between 0 and 180.

Fix version 1 and 2 of capsimulator. Add conditions for valid CAP and…

Branch help graduation

SimBowen · 2021-04-01T01:14:22Z

docs/DeveloperGuide.md

+Returning to module information menu...
+  ```
+Given below is the sequence diagram for the feature:  
+![Diagram](diagrams/addNewReview.png)  


Sequence diagram seems to be quite detailed, however may not follow the standard format. Do remember to also include the colon : at the front of the class.

Sequence diagram should not end in with the object at the bottom I think. Consider just leaving the dotted lines if the object is not destroyed?

SimBowen · 2021-04-01T01:22:45Z

docs/DeveloperGuide.md

+5) `Message` <br> Example: `Good job!`
+
+Given below is the sequence diagram for the feature:  
+![Diagram](diagrams/addNewTask.png)


The sequence diagram is very detailed, as such it may be a bit lengthy and confusing? Consider splitting the blocks into separate diagrams and explaining them separately.

SimBowen · 2021-04-01T01:28:51Z

docs/DeveloperGuide.md

+Returning to module information menu...
+  ```
+Given below is the sequence diagram for the feature:  
+![Diagram](diagrams/addNewReview.png)  


Diagrams are also missing () for the methods.

Consider standardizing the sequence diagrams as the other diagrams in 4.01 and 4.05 have the brackets

SimBowen · 2021-04-01T01:32:08Z

docs/DeveloperGuide.md

@@ -1,34 +1,315 @@
 # Developer Guide

-## Design & implementation
+## Table of Contents


The numberings of the content page do not line up

Additionally, the formatting of the sub sections are not standardized

Numbering in the sections themselves are ok.

soepaingzaw

Overall a comprehensive DG with aptly used sequence diagrams. Understandably, certain components are still in process. Further refinement will set you guys in for the final submission!

soepaingzaw · 2021-04-01T01:21:02Z

docs/DeveloperGuide.md

+**Problem**: When the user wants to review a module, he/she should be able to type ___multiple lines
+of input___, as reviews are generally long and detailed.
+
+**Solution**: A `while` loop is used to take in multiple lines of input until the input contains
+the `/end` symbol. Anything typed after this `/end` symbol will be erased.
+
+**When overwriting this review with a new review**: The old review will be printed for user
+reference. The user will also be alerted that this action will delete his/her old review via a log.
+The log is printed out as a warning.


Appreciate this form of writing due to readability and comprehension. Maybe this can be improved by mentioning the classes involved or methods involved? Similar to what was written in section 4.05.

soepaingzaw · 2021-04-01T01:28:23Z

docs/DeveloperGuide.md

+1) `Module Code` <br> Example: `CS2113T`
+2) `Task Description` <br> Example: `Finish v2.0`
+3) `Date` <br> Example: `2021-03-21`
+4) `Time` <br> Example: `23:59`
+5) `Message` <br> Example: `Good job!`


Explanation here may not be intuitive due to format and structure of presentation viewed on the DG:

Perhaps improving format can increase comprehension.

soepaingzaw · 2021-04-01T01:31:59Z

docs/DeveloperGuide.md

+This feature allows the user to add tasks of type `task`, `assignment`, `midterm`, `final exam` to a
+task list.
+
+All task types (except `Task`, which contains arguments 1, 2 and 5) contain 5 arguments upon


Best to standardize the capitalization of task types

soepaingzaw · 2021-04-01T01:43:12Z

docs/DeveloperGuide.md

+### 4.05 Add Zoom Link
+
+Given below is the sequence diagram for the feature:  
+![Diagram](diagrams/addZoomLink.png)


Good Sequence diagram. Perhaps it is alright to end the sequence diagram at the bottom with just lifelines? Maybe there is no need to end it with the object "boxes"

add changes suggested by peers from feedback

updated DG for introduction and task manager methods

no longer using that command

update AboutUs

fix AboutUs

add JavaDocs

update userguide on cap simulator.

Complete PPP.

update PPP.

fix checkstylemain in JavaDoc for Component class.

removed warning from DG + JavaDoc

update PPP and fix bug in moduleInfo.

make more OOP, fix acadamicRecords, ModuleGradeEnum prints to Ui class.

mc overflow fixed.

…into nikhila-UserGuide

UGDG final edits

fix bug.

nagiteja pushed a commit to nagiteja/tp that referenced this pull request Mar 17, 2021

Merge pull request nus-cs2113-AY2021S2#31 from KevinNgWK/master

68e82c4

Added Saving Functionality

s-t-e-f reviewed Mar 31, 2021

View reviewed changes

jovanhuang reviewed Mar 31, 2021

View reviewed changes

liping-eng and others added 8 commits April 1, 2021 00:56

Merge pull request #196 from liping-eng/branch-HelpGraduation

e63e55c

Add mc and grade (associated to module) to Module Storage.

tried fixing UG bugs at 3.3.3 and 3.3.5

5ba2283

changed will to may

4ec6226

Merge branch 'master' of https://github.com/AY2021S2-CS2113T-F08-4/tp …

2309ecc

…into nikhila-UserGuide

Merge pull request #197 from nivikcivik/nikhila-UserGuide

1631c01

Nikhila user guide

added delete task when module is deleted, fixed storage bug

a6a8202

Merge branch 'master' of https://github.com/AY2021S2-CS2113T-F08-4/tp …

fd60bdc

…into hazel-TaskManager # Conflicts: # UniTracker Data/modules.txt # src/main/java/seedu/duke/ModuleInfo.java

Merge pull request #199 from hazelhedmine/hazel-TaskManager

cdbd304

updated storage system and fixed delete task bug

KimIdeas8 reviewed Mar 31, 2021

View reviewed changes

hazelhedmine and others added 7 commits April 1, 2021 03:46

updated user docs with task manager features

08e78d1

Merge pull request #201 from hazelhedmine/hazel-UserGuide

f9d6633

updated user docs with task manager features

Fix version 1 and 2 of capsimulator. Add conditions for valid CAP and…

34e14c3

… set total number of MCs taken to range between 0 and 180.

Merge pull request #202 from liping-eng/branch-HelpGraduation

0b7e41c

Fix version 1 and 2 of capsimulator. Add conditions for valid CAP and…

Fix SU grade to not count into totalMcs.

f6c8736

Fix SU for version 2 of capSimulator. Add minor code changes.

5eb25e2

Merge pull request #203 from liping-eng/branch-HelpGraduation

8341011

Branch help graduation

SimBowen reviewed Apr 1, 2021

View reviewed changes

soepaingzaw reviewed Apr 1, 2021

View reviewed changes

motorpeople101 and others added 9 commits April 1, 2021 11:27

merge changes

7cff40e

add changes

57d9c5c

fixing merge conflicts

92d774c

add changes suggested by peers from feedback

3b0d1cd

Merge pull request #204 from BlubberMonster/master

d1e6c52

add changes suggested by peers from feedback

updated introduction section for dg

123e657

updated dg with sequence diagrams

ac35160

Merge pull request #206 from hazelhedmine/hazel-UserGuide

b0bd8db

updated DG for introduction and task manager methods

removed add/view mod description from UG

4ac6058

no longer using that command

motorpeople101 and others added 30 commits April 12, 2021 20:14

update AboutUs

1e063e3

Merge pull request #355 from BlubberMonster/master

46ff127

update AboutUs

fix AboutUs

3ab520a

Merge branch 'master' of https://github.com/AY2021S2-CS2113T-F08-4/tp

6affb7e

Merge pull request #356 from BlubberMonster/master

4d8305d

fix AboutUs

add JavaDocs

9bc01c3

Merge pull request #357 from liping-eng/master

8dabcbe

add JavaDocs

update userguide on cap simulator.

b9168fc

Merge pull request #358 from liping-eng/master

74d3300

update userguide on cap simulator.

Complete PPP.

7e70a63

Merge pull request #359 from liping-eng/master

8da94b8

Complete PPP.

update PPP.

f6f493c

Merge pull request #360 from liping-eng/master

6c2c201

update PPP.

fix checkstylemain in JavaDoc for Component class.

402f293

Merge pull request #361 from liping-eng/master

cc2f4d2

fix checkstylemain in JavaDoc for Component class.

removed warning from DG + JavaDoc

b2f0474

Merge pull request #364 from nivikcivik/nikhila-UserGuide

afd653f

removed warning from DG + JavaDoc

updated PPP links

725edb2

update PPP and fix bug in moduleInfo.

7dae762

Merge pull request #365 from liping-eng/master

4ba8ba4

update PPP and fix bug in moduleInfo.

make more OOP, fix acadamicRecords, ModuleGradeEnum prints to Ui class.

b706347

Merge pull request #366 from liping-eng/master

b3017bf

make more OOP, fix acadamicRecords, ModuleGradeEnum prints to Ui class.

fix up limit for total mcs.

0efbe87

fix mc overflow feature flaw.

5e61993

Merge pull request #367 from liping-eng/master

c208547

mc overflow fixed.

ugdg final edits

5d26bc4

Merge branch 'master' of https://github.com/AY2021S2-CS2113T-F08-4/tp …

01e15e5

…into nikhila-UserGuide

Merge pull request #369 from nivikcivik/nikhila-UserGuide

af44d2e

UGDG final edits

fix bug.

a93eaa5

Merge pull request #370 from liping-eng/master

7c8b292

fix bug.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2113T-F08-4] UniTracker #31

[CS2113T-F08-4] UniTracker #31

BlubberMonster commented Mar 5, 2021

s-t-e-f Mar 31, 2021

s-t-e-f Mar 31, 2021

s-t-e-f Mar 31, 2021

s-t-e-f Mar 31, 2021

jovanhuang left a comment

jovanhuang Mar 31, 2021

jovanhuang Mar 31, 2021

jovanhuang Mar 31, 2021

jovanhuang Mar 31, 2021

KimIdeas8 left a comment •

edited

Loading

KimIdeas8 Mar 31, 2021 •

edited

Loading

KimIdeas8 Mar 31, 2021

KimIdeas8 Mar 31, 2021

KimIdeas8 Mar 31, 2021

SimBowen Apr 1, 2021

SimBowen Apr 1, 2021

SimBowen Apr 1, 2021

SimBowen Apr 1, 2021

SimBowen Apr 1, 2021

soepaingzaw left a comment

soepaingzaw Apr 1, 2021

soepaingzaw Apr 1, 2021

soepaingzaw Apr 1, 2021

soepaingzaw Apr 1, 2021

		- `Storage`: Write data to, and loads data to hard disk

		![Diagram](diagrams/MainArchitecture.png)

[CS2113T-F08-4] UniTracker #31

Are you sure you want to change the base?

[CS2113T-F08-4] UniTracker #31

Conversation

BlubberMonster commented Mar 5, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jovanhuang left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KimIdeas8 left a comment • edited Loading

Choose a reason for hiding this comment

KimIdeas8 Mar 31, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soepaingzaw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KimIdeas8 left a comment •

edited

Loading

KimIdeas8 Mar 31, 2021 •

edited

Loading