[CS2113T-T12-3] OrgaNice! #9

terrytay · 2020-03-03T04:23:24Z

@NizarMohd
@GanapathySanathBalaji
@hongquan448

damithc · 2020-03-12T13:52:27Z

text-ui-test/ACTUAL.TXT

@@ -0,0 +1,47 @@
+Hello from


ACTUAL.TXT file should not be in git :-p

Thank you for the information Prof. We have stopped tracking ACTUAL.TXT in git.

mvp menu v4

jichngan

Please look at the review as given in the DeveloperGuide.md document.

jichngan · 2020-03-30T08:24:01Z

docs/DeveloperGuide.md

+[comment]: # (@@author GanapathySanathBalaji)
+### 2.1. Architecture  
+
+![Architecture](images/Architecture.png)


Good use of Architecture diagram to get an overview of the Software Architecture.

jichngan · 2020-03-30T08:24:27Z

docs/DeveloperGuide.md

+### 3.1. Scheduling Tasks 
+
+
+[comment]: # (@@author GanapathySanathBalaji)


You might have to explain what the "ref" frame as it is not included in our syllabus at the moment.

jichngan · 2020-03-30T08:27:14Z

docs/DeveloperGuide.md

+
+ ![Overall Sequence Diagram](images/Schedule_Overall.png)
+
+ The three reference frames used are as follows:


You might want to check why is there another instance of an object at end of the lifeline of an object.

jichngan · 2020-03-30T08:33:09Z

docs/DeveloperGuide.md

+
+Therefore, the first alternative is chosen, as it is easier to implement and lesser memory is used while 
+conducting the search.
+


Overall good usage of sequence diagrams to aid in the understanding of implementations. In the implementations section, it could be better if the steps during execution is listed out instead of writing the implementations in a long paragraph. Most of the sequence diagram has an object, which i assume is your main class, named as Duke. It could be better to either name it as main or your program name .

jichngan · 2020-03-30T08:43:42Z

docs/DeveloperGuide.md

+Therefore, the first alternative is chosen, as it is easier to implement and lesser memory is used while 
+conducting the search.
+
+[comment]: # (@@author )


Most of the sequence diagrams do not follow the standard notation of having just one instance of the class on the top. There is no need to mention the class again at the bottom. Please see the attached screenshot.

Bencotti

Great job detailing the workings of your project!

Bencotti · 2020-03-31T06:16:26Z

docs/DeveloperGuide.md

+1. Duke - Main component which controls the flow of execution.
+
+1. Ui - Component used to get input from the user and display results on the monitor.
+
+1. Parser - Component used to abstract out the command based on user's input, so that the command can be executed later.
+
+1. Command - Component contains information and implementation on how to execute various types of commands.
+
+1. Task - Component contains details about handling the task list and related operations.
+
+1. StudyArea - Component contains details about handling queries for study area search.
+
+1. Notes - Component contains details about Notes related operations.
+
+1. Exception - Component contains the various types of exceptions encountered when OrgaNice! is run.
+
+1. ResourceLoader - Component handles loading and saving of the task list and study area details to local storage.


I really appreciate this short portion, at a quick glance I'm able to understand what the core classes are purposed for. This will help new developers get up to speed fast, coupled together with the object diagram.

Bencotti · 2020-03-31T06:19:12Z

docs/DeveloperGuide.md

+[comment]: # (@@author GanapathySanathBalaji)
+### 2.1. Architecture  
+
+![Architecture](images/Architecture.png)


Would it make it clearer if different classes used unique colours or arrows to make it easier to differentiate the associations?

Bencotti · 2020-03-31T06:25:04Z

docs/DeveloperGuide.md

+[comment]: # (@@author terrytay)
+
+### 2.4. Notes Component
+![Notes Component](images/NotesComponent.png)


I felt the arrow leading from ModuleManager was quite confusing as the branch suddenly became curved, and almost overlaps the top arrow. This might make some look for a separate origin rather than thinking of a split.

It might be helpful to describe what CommandStack is for as it's the only floating unlinked object.

Bencotti · 2020-03-31T06:30:35Z

docs/DeveloperGuide.md

+ * `User enters search key` 
+
+![Study Area Sequence_Diagram_Main](images/user_sL_interaction.png)  
+<div>Figure 9. Interaction between User and Study Area Search Interface</div>


Is the format for replying back to user correct? Since it is a response, it might be easier to standardise and use a dotted arrow instead as with the rest of the diagram, to avoid confusion.

Bencotti · 2020-03-31T06:33:32Z

docs/DeveloperGuide.md

+
+### 3.3. Operation of Notes
+
+#### 3.3.1 Implementation 


This sections was a little too wordy, it might be better to have simple diagrams to help envision the flow as with the diagrams at the start.

Bencotti · 2020-03-31T06:36:34Z

docs/DeveloperGuide.md

+  {Give non-functional requirements}    
+
+[comment]: # (@@author NizarMohd)
+## Appendix D: Glossary    


Very detailed glossary, it might be easier to reference if it was used in a table instead, what do you think?

Bencotti · 2020-03-31T06:53:17Z

docs/DeveloperGuide.md

+[comment]: # (@@author terrytay)
+
+### 2.4. Notes Component
+![Notes Component](images/NotesComponent.png)


The wrong UML notation might have been used for this object diagram, such as the naming convention of each object

yuxianglim · 2020-03-31T07:39:04Z

docs/DeveloperGuide.md


-{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}


This part helps a lot in understanding the architecture of the program and the different classes and their functions efficiently. Good job!

yuxianglim · 2020-03-31T07:43:38Z

docs/DeveloperGuide.md

+[comment]: # (@@author GanapathySanathBalaji)
+### 2.1. Architecture  
+
+![Architecture](images/Architecture.png)


Maybe could consider making the arrows overlaps each other lesser so that it will be much neater or like bencotti suggested using unique colors or arrows. but good job anyway!

yuxianglim · 2020-03-31T07:48:16Z

docs/DeveloperGuide.md

+
+[comment]: # (@@author terrytay)
+
+### 3.3. Operation of Notes


Perhaps can consider adding some diagram or tables to illustrate the points so that readers can follow and flow easily.

yuxianglim · 2020-03-31T07:51:17Z

docs/DeveloperGuide.md

+ * *indoor_flag* - refers to "-i" flag
+ * *outdoor_flag* - refers to "-o" flag
+ * *size_flag* - refers to "-s" flag
+


Perhaps can consider putting this into a table or make the same space indentation so that it is easier to refer to.

yuxianglim · 2020-03-31T07:58:38Z

docs/DeveloperGuide.md

+ * To test for accuracy of flags, test either "-p", "-i", "-o" or "-s {integer}"
+#### Search with both, (1) location, name or address , and , (2) flags 
+ * To test for accuracy, test "{location/name/address} {flags}".
+ * Since flags must come as a second argument in this case, test for "{flags} {location/name/address}"


DG is very detailed and explains the classes well. Can consider doing a full rundown of the sequence of events with a diagram or numbered too. Goodjob:)

bennychanya · 2020-03-31T07:54:55Z

docs/DeveloperGuide.md

+[comment]: # (@@author GanapathySanathBalaji)
+### 2.1. Architecture  
+
+![Architecture](images/Architecture.png)


Clear general flow of program using Architecture diagram. Perhaps the arrow from StudyArea to Ui should be separated from the arrow from Command to StudyArea to avoid confusion?

bennychanya · 2020-03-31T08:21:23Z

docs/DeveloperGuide.md

+[comment]: # (@@author terrytay)
+
+### 2.4. Notes Component
+![Notes Component](images/NotesComponent.png)


Should the arrows be separated to clearly show the flow of the diagram?

bennychanya · 2020-03-31T08:23:00Z

docs/DeveloperGuide.md

+4. Command : Package containing Command interface, Add command, Command Stack classes.
+
+5. Parser : Class to parse commands for command-based operations.
+


Perhaps there should be an explanation for the role of the ModuleManager?

bennychanya · 2020-03-31T08:29:34Z

docs/DeveloperGuide.md

+
+   The following sequence diagrams explain how tasks are scheduled.
+
+ ![Overall Sequence Diagram](images/Schedule_Overall.png)


Should the word size of the diagram be increased or maybe the long commands could be split into 2 lines? It's quite hard to read the diagram without going closer to the screen.

bennychanya · 2020-03-31T10:07:24Z

docs/DeveloperGuide.md

+    the method will iterate through the flags array and check if the Study Area's attribute matches each flag stated in
+    flags. If isAvailStudyArea returns as true for all flags, the Study Area is then added to the output list, 
+    availStudyArea. 
+


Maybe some of these descriptions should be placed between the diagrams for diagram explanation.

bennychanya · 2020-03-31T10:09:25Z

docs/DeveloperGuide.md

+
+![Study_Area_Sequence_Diagram_subModules2](images/isAvailStudyArea.png)
+<div>Figure 11. Interaction when isAvailStudyArea is invoked</div>
+<br>


Clear diagram to showcase how the method works. Good job!

Update regarding Github pages

* 'master' of https://github.com/AY1920S2-CS2113T-T12-3/tp: Update regarding Github pages Make clear command request for confirmation before clearing list Introduce 3 new changes: 1) Both 'y' and 'Y' can be used for remove 2) Changed messages to be more meaningful 3) Trim whitespace for notes command

* master: Update regarding Github pages Make clear command request for confirmation before clearing list Introduce 3 new changes: 1) Both 'y' and 'Y' can be used for remove 2) Changed messages to be more meaningful 3) Trim whitespace for notes command # Conflicts: # src/main/java/notes/ModulesList.java # src/main/java/notes/NotesInvoker.java # src/main/java/ui/Constants.java

…nto branch-study-area * 'branch-study-area' of https://github.com/NizarMohd/tp: # Conflicts: # src/main/java/ui/Constants.java

update changes

* 'master' of https://github.com/AY1920S2-CS2113T-T12-3/tp: edit constants edit constants edit changes based on module manager Update regarding Github pages edit to pass check style edit to pass checkstyle integrated Ui with Notes Make clear command request for confirmation before clearing list Introduce 3 new changes: 1) Both 'y' and 'Y' can be used for remove 2) Changed messages to be more meaningful 3) Trim whitespace for notes command add exceptions to calendar edit UG and add exception to Calendar edit UG edit DG and add Calendar View to UG

Update doc links

Update Changes

Update changes

Update

* 'master' of https://github.com/AY1920S2-CS2113T-T12-3/tp: (26 commits) Update terrytay.md Update nizarmohd.md Update hongquan448.md Update ganapathysanathbalaji.md Update AboutUs.md Update README.md Update DeveloperGuide.md Update UserGuide.md Update README.md Update terrytay.md Update hongquan448.md Update ganapathysanathbalaji.md Update nizarmohd.md Update nizarmohd.md Update hongquan448.md Update terrytay.md Update ganapathysanathbalaji.md Update nizarmohd.md Update UserGuide.md Update DeveloperGuide.md ...

* 'master' of https://github.com/AY1920S2-CS2113T-T12-3/tp: Set theme jekyll-theme-cayman Delete Gemfile.lock Delete _config.yml Delete Gemfile Theme Theme Theme Test Delete Gemfile Test theme Update _config.yml Update _config.yml Update _config.yml Update DeveloperGuide.md Update UserGuide.md Update _config.yml

Change name of jar file

damithc reviewed Mar 12, 2020

View reviewed changes

damithc pushed a commit to damithc/tp-draft that referenced this pull request Mar 14, 2020

Merge pull request nus-cs2113-AY1920S2#9 from gmuthu17/master

e12fecc

mvp menu v4

jichngan reviewed Mar 30, 2020

View reviewed changes

Bencotti reviewed Mar 31, 2020

View reviewed changes

yuxianglim reviewed Mar 31, 2020

View reviewed changes

bennychanya reviewed Mar 31, 2020

View reviewed changes

NizarMohd and others added 24 commits April 8, 2020 00:04

edit to pass check style

7a1ef47

Update regarding Github pages

93e91e2

Merge pull request #201 from GanapathySanathBalaji/branch-Authorship

deb31e8

Update regarding Github pages

edit changes based on module manager

857496e

Merge branch 'master' into branch-study-area

7c9d27f

edit constants

fd6935d

Merge branch 'branch-study-area' of https://github.com/NizarMohd/tp i…

74186d5

…nto branch-study-area * 'branch-study-area' of https://github.com/NizarMohd/tp: # Conflicts: # src/main/java/ui/Constants.java

edit constants

391f31a

Merge pull request #202 from NizarMohd/branch-study-area

82e6674

update changes

Merge branch 'master' into branch-Authorship

22286ec

Update doc links

e6e2868

Merge pull request #203 from GanapathySanathBalaji/branch-Authorship

7e900ea

Update doc links

edit DG and Constants

1cbf2fd

edit UG

760be45

Merge pull request #204 from NizarMohd/branch-study-area

4eca244

Update Changes

add images

47e2eb6

edit changes and add images

ec73062

edit DG

4c40b1d

edit script src

0256a00

Merge pull request #205 from NizarMohd/branch-study-area

13dec8c

Update changes

Merge pull request #15 from AY1920S2-CS2113T-T12-3/master

e7411d9

Update

terrytay and others added 30 commits April 11, 2020 14:26

Update UserGuide.md

baf0a47

Update nizarmohd.md

4ad8080

Update ganapathysanathbalaji.md

9e2622f

Update terrytay.md

d2204e4

Update hongquan448.md

d2eb57b

Update nizarmohd.md

d685920

Update nizarmohd.md

fb40e13

Update ganapathysanathbalaji.md

0713318

Update hongquan448.md

1ec5acf

Update terrytay.md

748cefe

Update README.md

bba997f

Update UserGuide.md

87d1e91

Update DeveloperGuide.md

9ec7ddc

Update README.md

62e0dbd

Update AboutUs.md

dbb3531

Update ganapathysanathbalaji.md

d245ed5

Update hongquan448.md

1f022df

Update nizarmohd.md

e3d8117

Update terrytay.md

202dd03

Merge branch 'master' into master

e38a987

Delete Gemfile

37a0ec1

Delete _config.yml

5cc319b

Delete Gemfile.lock

7939105

Set theme jekyll-theme-cayman

d211590

Merge branch 'master' into branch-Authorship

ed2f9ea

Change name of jar file

63c83c0

Merge pull request #241 from GanapathySanathBalaji/branch-Authorship

7cf382e

Change name of jar file

Dummy

6b8d5f5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2113T-T12-3] OrgaNice! #9

[CS2113T-T12-3] OrgaNice! #9

terrytay commented Mar 3, 2020 •

edited

Loading

damithc Mar 12, 2020

GanapathySanathBalaji Mar 13, 2020

jichngan left a comment

jichngan Mar 30, 2020

jichngan Mar 30, 2020

jichngan Mar 30, 2020

jichngan Mar 30, 2020

jichngan Mar 30, 2020

Bencotti left a comment

Bencotti Mar 31, 2020

Bencotti Mar 31, 2020

Bencotti Mar 31, 2020

Bencotti Mar 31, 2020

Bencotti Mar 31, 2020

Bencotti Mar 31, 2020

Bencotti Mar 31, 2020

yuxianglim Mar 31, 2020

yuxianglim Mar 31, 2020

yuxianglim Mar 31, 2020

yuxianglim Mar 31, 2020

yuxianglim Mar 31, 2020

bennychanya Mar 31, 2020

bennychanya Mar 31, 2020

bennychanya Mar 31, 2020

bennychanya Mar 31, 2020

bennychanya Mar 31, 2020

bennychanya Mar 31, 2020

		### 3.1. Scheduling Tasks


		[comment]: # (@@author GanapathySanathBalaji)


		![Overall Sequence Diagram](images/Schedule_Overall.png)

		The three reference frames used are as follows:


		Therefore, the first alternative is chosen, as it is easier to implement and lesser memory is used while
		conducting the search.


		{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}

		4. Command : Package containing Command interface, Add command, Command Stack classes.

		5. Parser : Class to parse commands for command-based operations.


		The following sequence diagrams explain how tasks are scheduled.

		![Overall Sequence Diagram](images/Schedule_Overall.png)

[CS2113T-T12-3] OrgaNice! #9

Are you sure you want to change the base?

[CS2113T-T12-3] OrgaNice! #9

Conversation

terrytay commented Mar 3, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jichngan 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

Bencotti 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

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

terrytay commented Mar 3, 2020 •

edited

Loading