Merge pull request #224 from AY2324S2-CS2103T-T16-1/dedsecrattle-patch-2

Update README.md

README.md

@@ -12,7 +12,7 @@
   * It is based on the AddressBook-Level3 project, with additional tweaks and features to provide a customised experience for Academic Instructors.
   * From Address-Book Level-3 :- It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
   * It comes with a **reasonable level of user and developer documentation**.
-* It is named `EduLink NUS` because It Links Academic Instructors with their Past Students.
+* It is named `EduLink NUS` because It Links Academic Instructors with their Past and Current Students.
 * For the detailed documentation of this project, see the **[EduLink NUS Product Website](https://ay2324s2-cs2103t-t16-1.github.io/tp/)**.
 * This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
 

docs/DeveloperGuide.md

@@ -426,7 +426,7 @@ Design of Tag message:
     - **Cons**: Harder to manage user input. Less bug-provoking.
 
 
-### Undo/redo feature
+### Undo feature
 
 #### Implementation - Class Diagram:
 
@@ -436,23 +436,23 @@ Below is a representative class diagram of the feature. The implementation of th
 
 #### Implementation - Sequence Diagram:
 
-<puml src="diagrams/undo/UndoClassDiagram.puml" alt="UML Class Diagram - Undo"/>
+<puml src="diagrams/undo/UndoSequenceDiagram.puml" alt="UML Sequence Diagram - Undo"/>
 
 #### Design considerations:
 
-**Aspect: How undo & redo executes:**
+**Aspect: How undo executes:**
 
 * **Alternative 1 (current choice):** Saves the entire address book.
   * Pros: Easy to implement.
   * Cons: May have performance issues in terms of memory usage.
 
-* **Alternative 2:** Individual command knows how to undo/redo by
+* **Alternative 2:** Individual command knows how to undo by
   itself.
   * Pros: Will use less memory (e.g. for `delete`, just save the student being deleted).
   * Cons: We must ensure that the implementation of each individual command are correct.
 
 
-We decided to limit the number of Past History Saved to 20 i.e. User can only revert back from last 20 commands only to avoid the Performance issue and keep the implementation Simple.
+We decided to choose the Alternative 1 and limit the number of Past History Saved to 20 i.e. User can only revert back from last 20 commands only to avoid the Performance issue and keep the implementation Simple.
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -778,7 +778,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
       Use case resumes at step 5
 
-**Use Case: Edit the Information of a Student**
+#### Use Case: Edit the Information of a Student
 
 **MSS**
 
@@ -816,7 +816,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
       Use case ends.
 
-**Use Case: Delete a Student**
+#### Use Case: Delete a Student
 
 **MSS**
 
@@ -849,7 +849,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
       Use case resumes at step 5.
 
-**Use Case: Delete All Students in Filtered List**
+#### Use Case: Delete All Students in Filtered List
 
 **MSS**
 
@@ -919,7 +919,7 @@ Use case ends.
 
     Use case ends.
 
-**Use Case: Delete Grade from a Student**
+#### Use Case: Delete Grade from a Student
 
 **MSS**
 

docs/UserGuide.md

@@ -778,6 +778,7 @@ Furthermore, certain edits can cause the EduLink-NUS to behave in unexpected way
 
 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. **`NAME` Parameter**, if you try to enter a name that contains `/` the application will show error message about invalid format for `NAME` but someone can have `/` in their legal name e.g `Prabhat S/O Radhe`, this limitation arises due to usage of `/` character for Internal use within the Application. The remedy is to use `|` i.e. pipe character in place of `/`. We Understand that this format doesn't comply with their Legal Names but Since Our Application identifies students based on their StudentID , this remedy doesn't limit the Capabilities of EduLink-NUS in any possible way.
+3. **Student List Panel doesn't move**, if you click `UP` or `DOWN` arrow key to view Student Details Card for students even though the details card are shown correctly and changes perfectly according to the input , the Student List Panel doesn't scroll down or up to align or match with the current Student Displayed in the Details Card. The remedy is to scroll down manually to the highlighted Student Card in the Panel to know which student which being currently displayed.
 
 --------------------------------------------------------------------------------------------------------------------
 ## 7. Glossary