Merge pull request #27 from ryanlohyr/ryan/developer-guide

Create developer guide for pace feature

docs/DeveloperGuide.md

@@ -7,7 +7,35 @@
 ## Design & implementation
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+## Features
+- ### Pace Feature
+# Proposed Implementation - Pacing and MC Calculation
 
+The proposed "Pacing and MC Calculation" mechanism is implemented to help users track their academic progress and remaining Modular Credits (MCs) required for graduation. This feature is facilitated by the PacingManager, which stores user data and provides functions for calculating the recommended pacing and remaining MCs. The following operations are available:
+
+- PacingManager#calculateRemainingMCs() — Calculates the remaining MCs required for graduation.
+- PacingManager#calculateRecommendedPace() — Recommends the pacing for upcoming semesters.
+
+These operations are exposed in the Pacing interface as Pacing#calculateRemainingMCs() and Pacing#calculateRecommendedPace() respectively.
+
+## Usage Examples
+
+Here are a few examples of how the "Pacing and MC Calculation" feature behaves:
+
+### Example 1: Calculate Remaining MCs
+
+Command: `pace Y2/S1` (assuming that the user has completed 60 MCs from Y1S1 to Y2S1)
+
+Response:
+You currently have 100 MCs left until graduation.
+
+### Example 2: Calculate Remaining MCs (No Semester Specified)
+
+Command: `pace`
+
+Response:
+You currently have 100 MCs left until graduation.
+- ### Feature 2
 
 ## Product scope
 ### Target user profile

src/main/java/seedu/duke/CompletePreqs.java

@@ -1,5 +1,7 @@
 package seedu.duke;
 
+import seedu.duke.models.ModuleList;
+
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.HashSet;

src/main/java/seedu/duke/controllers/ModulePlannerController.java

@@ -1,7 +1,7 @@
 package seedu.duke.controllers;
 
 import seedu.duke.CompletePreqs;
-import seedu.duke.ModuleList;
+import seedu.duke.models.ModuleList;
 import seedu.duke.models.Major;
 import seedu.duke.models.Student;
 import seedu.duke.views.CommandLineView;

src/main/java/seedu/duke/ModuleList.java → src/main/java/seedu/duke/models/ModuleList.java

@@ -1,4 +1,4 @@
-package seedu.duke;
+package seedu.duke.models;
 
 import java.io.InvalidObjectException;
 import java.util.ArrayList;

src/main/java/seedu/duke/utils/Parser.java

@@ -3,7 +3,7 @@
 public class Parser {
 
     //we need to consider if
-    public boolean isValidAcademicYear(String userInput ) {
+    public boolean isValidAcademicYear( String userInput ) {
         try {
             String[] parts = userInput.split("/");
             if(parts.length != 2){

src/test/java/seedu/duke/ModuleListTest.java

@@ -1,6 +1,7 @@
 package seedu.duke;
 
 import org.junit.jupiter.api.Test;
+import seedu.duke.models.ModuleList;
 
 import java.io.InvalidObjectException;
 

src/test/java/seedu/duke/controllers/ModulePlannerControllerTest.java

@@ -4,7 +4,7 @@
 
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
-import seedu.duke.ModuleList;
+import seedu.duke.models.ModuleList;
 import seedu.duke.models.Major;
 
 import java.io.ByteArrayOutputStream;