[CS2113-F11-3] YetAnotherModuleOrganiserManager #20 #32

amitrahman1026 · 2022-10-10T12:23:43Z

An CLI that helps students to keep track of lessons, schedules and exam timetables
An CLI that can help set reminders for students
An CLI that can help students plan for their curriculum

P0tatoChips

No UML diagram, but so far, looks neat and readable. The alternatives considered and why is it implemented is really a nice touch.

P0tatoChips · 2022-10-26T03:31:28Z

docs/DeveloperGuide.md

+
+#### 3.5.3 Storage Component
+
+![Storage Class](..\docs\images\storageClass.png)


Photos does not work.

P0tatoChips · 2022-10-26T03:32:36Z

docs/DeveloperGuide.md


-## Product scope


Target user and value proposition not specified.

P0tatoChips · 2022-10-26T03:34:01Z

docs/DeveloperGuide.md

+Command class and are all in the command package.
+
+[//]: # (if the table is not necessary, remove it)
+| Command    | Command Type              | Action                                                                  |


Table not formatted properly, looks weird on the DG page.

P0tatoChips · 2022-10-26T03:34:52Z

docs/DeveloperGuide.md

+##### Why it is implemented this way.
+User may or may not know the exact module code or title. As such, the user can search for the module based on optional 
+parameters such as semester or level. However, the user must input at least the module code or title before additional 
+parameters can be added in order to refine the search.
+
+##### Alternatives considered.
+We thought of implementing the search feature in a way that the required user for multiple inputs and displaying all the
+different results after each input. However, we decided against it as it would be too tedious for the user to input 
+multiple times and the search process will be too long.


Like how you all got add the alternatives considered, help improve understanding of your point of view and why you choose to do things.

AmethystQ · 2022-10-26T05:11:22Z

docs/DeveloperGuide.md

+    - [3.3 Parser Component](#33-parser-component)
+    - [3.4 Command Component](#34-command-component)
+    - [3.5 Utils Component](#35-utils-component)
+      - [3.5.1 UI Component](#351-ui-component)


Maybe it's better to simplify the catalogue(for example, omit the 3.5.x because these are sub-subsections), in order to have better visual experience.

AmethystQ · 2022-10-26T05:14:33Z

docs/DeveloperGuide.md

+### 3.2 Model Component
+
+### 3.3 Parser Component
+![Parser Class](..\docs\images\parserClass.png)  


This image fails to show on the develper guide on my laptop.

AmethystQ · 2022-10-26T05:17:32Z

docs/DeveloperGuide.md

+| `bye`      | `ExitCommand`             | Exits the program.                                                      |
+| `nil`      | `InvalidCommand`          | Displays the invalid command message.                                   |
+| `nil`      | `IncompleteModuleCommand` | Display the incomplete command message.                                 |
+| `nil`      | `UnknownCommand`          | Display the unknown command message.                                    |


The table looks a bit messy on my laptop

AmethystQ · 2022-10-26T05:25:21Z

docs/DeveloperGuide.md

+
+Core program flow is managed by the Duke class. 
+
+![Main Program Flow](images/mainProgramFlow.png)


The cross in the command class seems to overlap the activation bar

AaaaaronC

In general, the class diagrams should use the same software to make. The format for some classes differ from the rest.

AaaaaronC · 2022-10-27T09:21:40Z

docs/DeveloperGuide.md

+  - [Appendix C: Non-Functional Requirements](#appendix-c-non-functional-requirements)
+  - [Appendix D: Glossary](#appendix-d-glossary)
+  - [Appendix E: Acknowledgements](#appendix-e-acknowledgements)
+    - [Third-party libraries](#third-party-libraries)



Seems like the appendices below are duplicated. Both lead to the same component, maybe can delete the bottom one?

AaaaaronC · 2022-10-27T09:25:19Z

docs/DeveloperGuide.md

+Below is a table of command subclasses and their respective command type. The different command types extends from the
+Command class and are all in the command package.
+
+[//]: # (if the table is not necessary, remove it)


Table is not implemented properly, does not render

AaaaaronC · 2022-10-27T09:26:43Z

docs/DeveloperGuide.md

+The <code>AddModuleCommand</code> class extends from the <code>Command</code> class and adds the user input module into
+their timetable.
+
+![AddModuleCommand Class](..\docs\images\addModuleCommandClass.png)


image does not render, maybe check file path?

AaaaaronC · 2022-10-27T09:30:52Z

docs/DeveloperGuide.md

-* *glossary item* - Definition
+Special thanks to the author of the following sources for inspiration and ideas that contributed to the development of 
+**YAMOM**
+- https://stackoverflow.com/questions/25853393


if this is a link, you might want to make it selectable

AaaaaronC · 2022-10-27T09:36:12Z

docs/DeveloperGuide.md

+
+#### 3.5.1 UI Component
+
+![UI Class](images/Ui.png)


for this image, the class diagram C should not be there

matthewphua · 2022-10-27T09:28:59Z

docs/DeveloperGuide.md

+Initially, data validation was being handled by the `Parser` class, however in the principles of avoiding tight coupling
+and improving cohesion, it was moved back under the `AddModuleCommand` class.
+
+#### 3.4.2 DeleteModuleCommand


Perhaps add a sequence diagram to the commands that you missed to provide further info for users

matthewphua · 2022-10-27T09:35:23Z

docs/DeveloperGuide.md

+The <code>AddModuleCommand</code> class extends from the <code>Command</code> class and adds the user input module into
+their timetable.
+
+![AddModuleCommand Class](..\docs\images\addModuleCommandClass.png)


The alt condition is a little misleading. Both conditions call on AddMessage() and they are linked by an activation box is a bit confusing to understand.

matthewphua · 2022-10-27T09:38:28Z

docs/DeveloperGuide.md

+
+Core program flow is managed by the Duke class.
+
+![Main Program Flow](images/mainProgramFlow.png)


Is get/update state one function or two separate functions

matthewphua · 2022-10-27T09:44:47Z

docs/DeveloperGuide.md

+| `search`     | `SearchModuleCommand`              | Searches similar modules based on code, title, semester or level.  |
+| `semester`   | `SelectSemesterCommand`            | Selects the semester that the user want.                           |
+| `select`     | `SelectSlotCommand`                | Selects the time slot for the different lesson types.              |
+| `view`       | `ViewCommand`                      | Views the user timetable with user's selected modules.             |


The table when rendered becomes unaligned. I've attached a picture for your reference.

JordanKwua

Overall good effort, the errors mostly come from the configuration settings for plantUML, the elaboration of the methods are well done.

JordanKwua · 2022-10-27T09:26:19Z

docs/DeveloperGuide.md

+
+Core program flow is managed by the Duke class.
+
+![Main Program Flow](images/mainProgramFlow.png)


The end of the lifeline (cross) should be clearer, should it be overlapping the activation bar?

JordanKwua · 2022-10-27T09:39:54Z

docs/DeveloperGuide.md

+
+### 3.4 Command Component
+
+![Command Abstract Class](images/commandClass.png)


Consider the symbols beside the variables and methods, maybe you should check the right format to show visibility?

JordanKwua · 2022-10-27T09:42:28Z

docs/DeveloperGuide.md

+| `search`     | `SearchModuleCommand`              | Searches similar modules based on code, title, semester or level.  |
+| `semester`   | `SelectSemesterCommand`            | Selects the semester that the user want.                           |
+| `select`     | `SelectSlotCommand`                | Selects the time slot for the different lesson types.              |
+| `view`       | `ViewCommand`                      | Views the user timetable with user's selected modules.             |


Should it be like this on the actual DG? Because the formatting seems to be wrong.

JordanKwua · 2022-10-27T09:48:26Z

docs/DeveloperGuide.md

+
+The following sequence diagram shows how the undo operation works:
+
+![AddModuleCommandSequenceDiagram](images/AddModuleCommandSequenceDiagram.png)


Do consider changing the configuration of your plantUML as the diagrams are off , such as this object box at the bottom of the lifeline.

naz019 · 2022-10-27T09:29:05Z

docs/DeveloperGuide.md

+
+Core program flow is managed by the Duke class.
+
+![Main Program Flow](images/mainProgramFlow.png)


Do remember to deactivate the activation bar so that there is closure.

naz019 · 2022-10-27T09:35:27Z

docs/DeveloperGuide.md

+
+### 3.4 Command Component
+
+![Command Abstract Class](images/commandClass.png)


In this diagram, the accessibility of the fields and methods are represented by different symbols than the ones we learnt in class. Maybe you can consider disabling skinparams to use the correct symbols?

naz019 · 2022-10-27T09:41:40Z

docs/DeveloperGuide.md

+
+### Storage feature
+
+!["Opening saved state"](images/storageOpenPreviousState.png)  


Are these activation bars supposed to be left open? Are they supposed to have return arrows?

naz019 · 2022-10-27T09:46:40Z

docs/DeveloperGuide.md

+
+#### 3.5.1 UI Component
+
+![UI Class](images/Ui.png)


Are these the right accessibility symbols to use?

Add model class diagram

…into owen/dg

Fix line breaks in description

More integration tests

Fix bug in module code

Update class diagram for model

add more tests

Refactor

Update main sequence diagram

Update class diagrams

Edit ppp

Shorten PPP

# Conflicts: # src/main/java/seedu/duke/parser/Parser.java

edited profile code link

…v2_1_updates

Documentation Update (Hao Yi)

Minor indentation fixes

Fix Content Page

ppp typo

Add and remove sequence diagram

fix object diagram

Update README.md

P0tatoChips reviewed Oct 26, 2022

View reviewed changes

AmethystQ reviewed Oct 26, 2022

View reviewed changes

AaaaaronC reviewed Oct 27, 2022

View reviewed changes

matthewphua reviewed Oct 27, 2022

View reviewed changes

JordanKwua reviewed Oct 27, 2022

View reviewed changes

naz019 reviewed Oct 27, 2022

View reviewed changes

owenl131 and others added 24 commits October 28, 2022 10:14

Refactor Day

72eb182

Add model class diagram

c25e791

Add parser into the model class diagram

4a48756

Merge pull request #138 from owenl131/owen/dg

d962f0a

Add model class diagram

Update model class diagram

023c7f7

Merge branch 'master' of https://github.com/AY2223S1-CS2113-F11-3/tp …

4ecb079

…into owen/dg

Merge pull request #134 from owenl131/owen/fix-linebreaks-get-command

e5f2f23

Fix line breaks in description

Merge pull request #133 from owenl131/owen/more-integration-tests

4d6d524

More integration tests

Merge pull request #137 from owenl131/owen/module-bug

fddd769

Fix bug in module code

Merge pull request #139 from owenl131/owen/dg

9af4b30

Update class diagram for model

Merge pull request #135 from kohnh/KohNgiapHin-tests

7ea191a

add more tests

validation and tests for select module command

8220cf6

updated user guide

6c655e4

changed to assertThrows

f30846e

updated select slot validation test

83b8fea

pass gradlew and removed actual.txt

228558e

Refactor

1cba5ae

Update main sequence diagram

aec5d17

Merge pull request #141 from owenl131/owen/cleanup

383f7cf

Refactor

Merge pull request #143 from owenl131/owen/dg

8a09cd2

Update main sequence diagram

Align help, remove unnecessary functions

97a312a

Validation for search module command

1948cf8

Fix link class to handle all errors

9a165cd

Boost test coverage

c77b162

deenliong and others added 30 commits November 6, 2022 22:01

Merge pull request #233 from kohnh/KohNgiapHin-documentation

7a2889f

Update class diagrams

Merge branch 'master' into deen-ppp

4583f6b

Edit PPP

307f64d

Merge branch 'master' into KohNgiapHin-documentation

7a729ab

Merge pull request #235 from kohnh/KohNgiapHin-documentation

1b7b294

Edit ppp

Shorten PPP

ab87a16

Merge pull request #236 from kohnh/KohNgiapHin-documentation

7214b9e

Shorten PPP

minor changes

6c62e43

Merge branch 'master' of https://github.com/AY2223S1-CS2113T-F11-3/tp

ed40e0c

# Conflicts: # src/main/java/seedu/duke/parser/Parser.java

Merge pull request #234 from deenliong/deen-ppp

913c583

edited profile code link

Add documentation for V2.1

7af2940

Merge branch 'master' of https://github.com/AY2223S1-CS2113T-F11-3/tp

6131073

Merge branch 'master' of https://github.com/CheahHaoYi/tp into haoyi/…

83146c8

…v2_1_updates

Minor change in documentation based on TA feedback

50f3e34

Merge pull request #237 from CheahHaoYi/haoyi/v2_1_updates

cfc7633

Documentation Update (Hao Yi)

Minor indentation fixes

54062e8

Merge pull request #238 from CheahHaoYi/haoyi/v2_1_updates

bd5a21c

Minor indentation fixes

Fix Content Page

7f78c9c

Merge pull request #239 from CheahHaoYi/haoyi/v2_1_updates

3d697cf

Fix Content Page

ppp typo

ba26bf1

Merge pull request #240 from amitrahman1026/tests

a69c004

ppp typo

Update UserGuide.md

280b787

new image

0ca3c8d

added remove sequence diagram

65d9514

add ui class

6944cd0

Merge pull request #241 from deenliong/Add-and-Remove-sequence-diagram

b699db9

Add and remove sequence diagram

fix object diagram

533714a

Merge pull request #242 from amitrahman1026/tests

b2f5149

fix object diagram

Update README.md

6e84a58

Merge pull request #243 from AY2223S1-CS2113-F11-3/owenl131-patch-1

8706d95

Update README.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2113-F11-3] YetAnotherModuleOrganiserManager #20 #32

[CS2113-F11-3] YetAnotherModuleOrganiserManager #20 #32

amitrahman1026 commented Oct 10, 2022

P0tatoChips left a comment

P0tatoChips Oct 26, 2022

P0tatoChips Oct 26, 2022

P0tatoChips Oct 26, 2022

P0tatoChips Oct 26, 2022

AmethystQ Oct 26, 2022

AmethystQ Oct 26, 2022

AmethystQ Oct 26, 2022

AmethystQ Oct 26, 2022

AaaaaronC left a comment

AaaaaronC Oct 27, 2022

AaaaaronC Oct 27, 2022

AaaaaronC Oct 27, 2022

AaaaaronC Oct 27, 2022

AaaaaronC Oct 27, 2022

matthewphua Oct 27, 2022

matthewphua Oct 27, 2022

matthewphua Oct 27, 2022

matthewphua Oct 27, 2022

JordanKwua left a comment

JordanKwua Oct 27, 2022

JordanKwua Oct 27, 2022

JordanKwua Oct 27, 2022

JordanKwua Oct 27, 2022

naz019 Oct 27, 2022

naz019 Oct 27, 2022

naz019 Oct 27, 2022

naz019 Oct 27, 2022


		#### 3.5.3 Storage Component

		![Storage Class](..\docs\images\storageClass.png)


		Core program flow is managed by the Duke class.

		![Main Program Flow](images/mainProgramFlow.png)


		### 3.4 Command Component

		![Command Abstract Class](images/commandClass.png)


		The following sequence diagram shows how the undo operation works:

		![AddModuleCommandSequenceDiagram](images/AddModuleCommandSequenceDiagram.png)


		### Storage feature

		!["Opening saved state"](images/storageOpenPreviousState.png)

[CS2113-F11-3] YetAnotherModuleOrganiserManager #20 #32

Are you sure you want to change the base?

[CS2113-F11-3] YetAnotherModuleOrganiserManager #20 #32

Conversation

amitrahman1026 commented Oct 10, 2022

P0tatoChips 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

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

AaaaaronC 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

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

JordanKwua 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

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