Merge pull request #261 from yongqqqq/branch-PED-bugfixes

Update UG to state case-sensitivity

docs/DeveloperGuide.md

@@ -173,7 +173,17 @@ The following is an example JSON output for a person:
 Classes used by multiple components are in the `seedu.address.commons` package.
 
 --------------------------------------------------------------------------------------------------------------------
+## General Flow
+The activity diagram below illustrates the general flow of an interaction between the user and StoreClass.
 
+<img src="images/GeneralFlowActivity.png" width="1000" />
+
+1. The user enters a command in the `CommandBox`.
+2. The AddressBookParser parses the command.
+3. If the command is a valid command and is of a valid format, the corresponding `Command` object is created.
+4. The `Command` object is executed by the `Logic` component.
+5. The `UI` component displays the result of the command execution to the user.
+---
 ## **Implementation**
 
 This section describes some noteworthy details on how certain features are implemented.
@@ -290,13 +300,6 @@ The following sequence diagram shows how the redo operation works across the `Lo
 
 ![UndoRedoState5](images/UndoRedoState5.png)
 
----
-
-The following activity diagram summarizes what happens when a user executes a new command:
-
-<img src="images/CommitActivityDiagram.png" width="250" />
-
-
 ---
 
 ## Design Considerations

docs/UserGuide.md

@@ -113,6 +113,11 @@ Format: `add n/NAME p/PHONE_NUMBER g/GENDER m/MODULE... [t/TAG]…​`
 - Tag should consist of alphanumeric characters only, and it should be between 1 and 30 characters long.
 </div>
 
+<div markdown="span" class="alert alert-danger">⚠️ **Warning:**
+- Students with same name, regardless of case-sensitivity, will be considered as the same student and will not be added.
+- Modules and tags are case-sensitive and will be added as they are.
+</div>
+
 Examples:
 * `add n/John Doe p/98765432 g/male m/Mathematics` : Adds a student named `John Doe` to StoreClass.
 * `add n/Betsy Crowe g/female p/12345678 m/Physics m/Chemistry t/OLevels t/new` : Adds a student named `Betsy Crowe` to StoreClass.
@@ -467,7 +472,9 @@ Furthermore, certain edits can cause the StoreClass to behave in unexpected ways
 
 1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again.
 2. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.
-3. **When the UI window is set to a small size** certain element in the UI maybe hard to view. E.g. modules, long names... Hence, we recommend you to use a large screen and a large window size when using our product so that all the fields can be viewed clearly.
+3. **After inputting a command**, the scroll bar in the command box becomes unresponsive. The remedy is to click on the scroll bar to make it responsive again.
+4. **When the UI window is set to a small size** certain element in the UI maybe hard to view. E.g. modules, long names... Hence, we recommend you to use a large screen and a large window size when using our product so that all the fields can be viewed clearly.
+
 
 --------------------------------------------------------------------------------------------------------------------
 

docs/diagrams/GeneralFlowActivity.puml

@@ -0,0 +1,39 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+start
+
+:User enters a command;
+:Parser parses the command;
+
+if () then ([valid command])
+    if () then ([Exit Command])
+        :Exit command is created;
+        :Exit command is executed;
+        stop
+    else ([not Exit Command])
+        if () then ([Help Command])
+            :Help command is created;
+            :Help command is executed;
+            :UI displays Help window;
+            stop
+        else ([Other commands])
+            :Respective parser parses arguments of specified command;
+            if () then ([valid format])
+                :Command is created;
+                :Command is executed;
+                :UI displays executed message;
+                stop
+            else ([invalid format])
+                :UI displays an error message;
+                stop
+            endif
+        endif
+    endif
+else ([invalid command])
+    :UI displays an error message;
+    stop
+endif
+
+@enduml