Merge pull request #343 from Originalidk/master

Update UG and APP parameters

docs/UserGuide.md

@@ -528,12 +528,12 @@ This section describes commands that help you manage your students.
 You can add a student to F.A.K.E.J.A.R.V.I.S. if you need to keep track of new students.
 
 
-Format: `add n/NAME p/PHONE_NUMBER e/EMAIL th/TELEGRAM_HANDLE [t/TAG]…​ [gt/GRADED_TEST]`
+Format: `add n/NAME p/PHONE e/EMAIL th/TELEGRAM_HANDLE [t/TAG]…​ [gt/GRADED_TEST]`
 
 |  **Parameter**  |                       **Description**                       |
 |:---------------:|:-----------------------------------------------------------:|
 |      NAME       |                  The name of the student.                   |
-|  PHONE_NUMBER   |              The phone number of the student.               |
+|      PHONE      |              The phone number of the student.               |
 |      EMAIL      |              The email address of the student.              |
 | TELEGRAM_HANDLE |             The telegram handle of the student.             |
 |       TAG       |            The tags associated with the student.            |
@@ -751,13 +751,13 @@ This section describes commands that help you manage your tasks.
 
 You can add a task to your task list if you have a new item to include in your list of things to do.
 
-Format: `addtask tn/TASK_NAME [td/TASK_DESCRIPTION] [d/DUE_DATE] [tp/TASK_PRIORITY]`
+Format: `addtask tn/TASK_NAME [td/TASK_DESCRIPTION] [d/DATE] [tp/TASK_PRIORITY]`
 
 |  **Parameter**   |                           **Description**                           |
 |:----------------:|:-------------------------------------------------------------------:|
 |    TASK_NAME     |                        The name of the task.                        |
 | TASK_DESCRIPTION |                    The description of the task.                     |
-|     DUE_DATE     |                The due date or deadline of the task.                |
+|       DATE       |                The due date or deadline of the task.                |
 |  TASK_PRIORITY   | The priority level of the task. Given as `HIGH`, `MEDIUM` or `LOW`. |
 
 <br>
@@ -777,13 +777,13 @@ Format: `addtask tn/TASK_NAME [td/TASK_DESCRIPTION] [d/DUE_DATE] [tp/TASK_PRIORI
 
 You can view your list of tasks if you want to check and manage your current set of to-do list.
 
-Format: `viewtasks [tn/TASK_NAME] / [td/TASK_DESCRIPTION] / [d/DUE_DATE] / [tp/TASK_PRIORITY] / [tprog/TASK_PROGRESS]`
+Format: `viewtasks [tn/TASK_NAME] / [td/TASK_DESCRIPTION] / [d/DATE] / [tp/TASK_PRIORITY] / [tprog/TASK_PROGRESS]`
 
 |  **Parameter**   |                               **Description**                                |
 |:----------------:|:----------------------------------------------------------------------------:|
 |    TASK_NAME     |                            The name of the task.                             |
 | TASK_DESCRIPTION |                         The description of the task.                         |
-|     DUE_DATE     |                    The due date or deadline of the task.                     |
+|       DATE       |                    The due date or deadline of the task.                     |
 |  TASK_PRIORITY   |     The priority level of the task. Given as `HIGH`, `MEDIUM` or `LOW`.      |
 |  TASK_PROGRESS   | The progress level of the task. Given as `DONE`, `PENDING` or `NOT_STARTED`. |
 
@@ -922,7 +922,7 @@ This section describes commands that help you manage your students' attendance.
 
 You can take the attendance of your student(s) if you need to record their presence for a session.
 
-Format: `takeattendance n/STUDENT_NAME s/SESSION_NUMBER ap/PRESENCE`
+Format: `takeattendance n/NAME s/SESSION_NUMBER ap/PRESENCE`
 
 
 | **Parameter**  |                            **Description**                            |
@@ -964,11 +964,11 @@ Format: `takeattendance n/STUDENT_NAME s/SESSION_NUMBER ap/PRESENCE`
 
 You can view the attendance list of your students if you want to check and review their attendance records.
 
-Format: `viewattendance [n/STUDENT_NAME]…`
+Format: `viewattendance [n/NAME]…`
 
 | **Parameter** |                        **Description**                         |
 |:-------------:|:--------------------------------------------------------------:|
-| STUDENT_NAME  | The name of the student(s) you want to view the attendance of. |
+|     NAME      | The name of the student(s) you want to view the attendance of. |
 
 <br>
 
@@ -1300,12 +1300,12 @@ This section describes commands that help you manage your sessions.
 
 You can create a session for any upcoming or past sessions if you need to schedule or document your class sessions in the system.
 
-Format: `createsession s/SESSION_NUMBER n/STUDENT_NAME…`
+Format: `createsession s/SESSION_NUMBER [n/NAME]…`
 
 | **Parameter**  |          **Description**           |
 |:--------------:|:----------------------------------:|
 | SESSION_NUMBER | The session number of the session. |
-|  STUDENT_NAME  |    The name of the student(s).     |
+|      NAME      |    The name of the student(s).     |
 
 <br>
 
@@ -1339,12 +1339,12 @@ Format: `createsession s/SESSION_NUMBER n/STUDENT_NAME…`
 
 You can update an existing session's remark if you need to change or add additional information to the session notes or details.
 
-Format: `updatesessionremark s/SESSION_NUMBER r/REMARK`
+Format: `updatesessionremark s/SESSION_NUMBER r/SESSION_REMARK`
 
 | **Parameter**  |                **Description**                |
 |:--------------:|:---------------------------------------------:|
 | SESSION_NUMBER |      The session number of the session.       |
-|     REMARK     | The new remark to be updated for the session. |
+| SESSION_REMARK | The new remark to be updated for the session. |
 
 <br>
 
@@ -1424,13 +1424,13 @@ This section describes commands that help you manage your consultations with stu
 #### 📝Creating a Consultation: `createconsult`
 You can create a consultation with your students if you need to schedule or document consultations in the system.
 
-Format: `createconsult d/DATE tt/TIME n/STUDENT_NAME…`
+Format: `createconsult d/DATE tt/TIME [n/NAME]…`
 
-| **Parameter**  |       **Description**       |
-|:--------------:|:---------------------------:|
-|      DATE      |  The date of consultation.  |
-|      TIME      |  The time of consultation.  |
-|  STUDENT_NAME  | The name of the student(s). |
+| **Parameter** |       **Description**       |
+|:-------------:|:---------------------------:|
+|     DATE      |  The date of consultation.  |
+|     TIME      |  The time of consultation.  |
+|     NAME      | The name of the student(s). |
 
 <br>
 
@@ -1463,12 +1463,12 @@ Format: `createconsult d/DATE tt/TIME n/STUDENT_NAME…`
 #### 📝️Adding Students to a Consultation: `addtoconsult`
 You can add your student(s) into a consultation slot if you need to track students in your consultations.
 
-Format: `addtoconsult CONSULTATION_INDEX n/STUDENT_NAME…`
+Format: `addtoconsult CONSULTATION_INDEX n/NAME…`
 
 |   **Parameter**    |                           **Description**                            |
 |:------------------:|:--------------------------------------------------------------------:|
 | CONSULTATION_INDEX | The index of the consultation in the list of upcoming consultations. |
-|    STUDENT_NAME    |       The name of the student to be added to the consultation.       |
+|        NAME        |       The name of the student to be added to the consultation.       |
 
 <br>
 
@@ -1506,12 +1506,12 @@ Format: `addtoconsult CONSULTATION_INDEX n/STUDENT_NAME…`
 
 You can remove your student(s) from a consultation if you need to cancel your student's participation in the scheduled consultation.
 
-Format: `removefromconsult CONSULTATION_INDEX n/STUDENT_NAME…`
+Format: `removefromconsult CONSULTATION_INDEX n/NAME…`
 
 |   **Parameter**    |                           **Description**                            |
 |:------------------:|:--------------------------------------------------------------------:|
 | CONSULTATION_INDEX | The index of the consultation in the list of upcoming consultations. |
-|    STUDENT_NAME    |     The name of the student to be removed from the consultation.     |
+|        NAME        |     The name of the student to be removed from the consultation.     |
 
 <br>
 

src/main/java/seedu/address/logic/commands/AddTaskCommand.java

@@ -22,15 +22,15 @@ public class AddTaskCommand extends Command {
     public static final String MESSAGE_USAGE = COMMAND_WORD
             + ": Adds a new task with the specified description.\n"
             + "Parameters: "
-            + PREFIX_TASK_NAME + "NAME "
-            + "[" + PREFIX_TASK_DESCRIPTION + "DESCRIPTION] "
-            + "[" + PREFIX_TASK_PRIORITY + "PRIORITY] "
+            + PREFIX_TASK_NAME + "TASK_NAME "
+            + "[" + PREFIX_TASK_DESCRIPTION + "TASK_DESCRIPTION] "
             + "[" + PREFIX_DATE + "DATE]\n"
+            + "[" + PREFIX_TASK_PRIORITY + "TASK_PRIORITY] "
             + "Example: " + COMMAND_WORD + " "
             + PREFIX_TASK_NAME + "Do laundry "
             + PREFIX_TASK_DESCRIPTION + "Wash the clothes and pants in basket "
-            + PREFIX_TASK_PRIORITY + "medium "
-            + PREFIX_DATE + "22/10/2023 ";
+            + PREFIX_DATE + "22/10/2023 "
+            + PREFIX_TASK_PRIORITY + "medium ";
 
     public static final String MESSAGE_SUCCESS = "Task has been added: %1$s";
 

src/main/java/seedu/address/logic/commands/AddToConsultCommand.java

@@ -33,8 +33,8 @@ public class AddToConsultCommand extends Command {
     public static final String COMMAND_WORD = "addtoconsult";
 
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a student to a consultation at INDEX."
-        + "Parameters: INDEX (must be a positive integer) "
-        + "[" + PREFIX_NAME + "NAME]...\n"
+        + "Parameters: CONSULTATION_INDEX (must be a positive integer) "
+        + PREFIX_NAME + "NAME...\n"
         + "Example: " + COMMAND_WORD + " "
         + PREFIX_NAME + "John Doe ";
 

src/main/java/seedu/address/logic/commands/DeleteCommand.java

@@ -20,7 +20,7 @@ public class DeleteCommand extends Command {
 
     public static final String MESSAGE_USAGE = COMMAND_WORD
             + ": Deletes the person identified by the index number used in the displayed person list.\n"
-            + "Parameters: INDEX (must be a positive integer)\n"
+            + "Parameters: STUDENT_INDEX (must be a positive integer)\n"
             + "Example: " + COMMAND_WORD + " 1";
 
     public static final String MESSAGE_DELETE_PERSON_SUCCESS = "Deleted Person: %1$s";

src/main/java/seedu/address/logic/commands/DeleteConsultationCommand.java

@@ -19,8 +19,8 @@ public class DeleteConsultationCommand extends Command {
 
     public static final String MESSAGE_USAGE = COMMAND_WORD
             + ": Deletes the consultation identified by the index number used in the displayed consultation list.\n"
-            + "Parameters: INDEX (must be a positive integer)\n"
-            + "Example: " + COMMAND_WORD + 1;
+            + "Parameters: CONSULTATION_INDEX (must be a positive integer)\n"
+            + "Example: " + COMMAND_WORD + " " + 1;
 
     public static final String MESSAGE_DELETE_CONSULTATION_SUCCESS = "Deleted Consultation: %1$s";
 

src/main/java/seedu/address/logic/commands/DeleteTaskCommand.java

@@ -20,7 +20,7 @@ public class DeleteTaskCommand extends Command {
 
     public static final String MESSAGE_USAGE = COMMAND_WORD
             + ": Deletes the task identified by the index number used in the displayed task list.\n"
-            + "Parameters: INDEX (must be a positive integer)\n"
+            + "Parameters: TASK_INDEX (must be a positive integer)\n"
             + "Example: " + COMMAND_WORD + " 1";
 
     public static final String MESSAGE_DELETE_TASK_SUCCESS = "Deleted Task: %1$s";

src/main/java/seedu/address/logic/commands/RemoveFromConsultCommand.java

@@ -35,7 +35,7 @@ public class RemoveFromConsultCommand extends Command {
     public static final String MESSAGE_USAGE = COMMAND_WORD
             + ": Removes a person identified using his/her name from the specified consultation. "
             + "The consultation is specified by its index in the displayed consultation list.\n"
-            + "Parameters: INDEX (must be a positive integer) "
+            + "Parameters: CONSULTATION_INDEX (must be a positive integer) "
             + PREFIX_NAME + "NAME\n"
             + "Example: " + COMMAND_WORD + " 1" + PREFIX_NAME + "John Doe";
 

src/main/java/seedu/address/logic/commands/TabCommand.java

@@ -14,7 +14,7 @@ public class TabCommand extends Command {
     public static final String COMMAND_WORD = "tab";
 
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Switches tab based on index.\n"
-            + "Parameters: INDEX (ranging from 1 for Students to 5 for Consultations)\n"
+            + "Parameters: TAB_INDEX (ranging from 1 for Students to 5 for Consultations)\n"
             + "Example: " + COMMAND_WORD + " 1";
 
     public static final String MESSAGE_SUCCESS = "Switched to tab %1$s";

src/main/java/seedu/address/logic/commands/TakeAttendanceCommand.java

@@ -34,13 +34,13 @@ public class TakeAttendanceCommand extends Command {
     public static final String COMMAND_WORD = "takeattendance";
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Takes the attendance of student(s). "
             + "Parameters: "
-            + PREFIX_SESSION + "SESSION_NUMBER "
             + PREFIX_NAME + "NAME... "
+            + PREFIX_SESSION + "SESSION_NUMBER "
             + PREFIX_ATTENDANCE_PRESENCE + "ATTENDANCE_PRESENCE\n"
             + "Example: " + COMMAND_WORD + " "
-            + PREFIX_SESSION + "3 "
             + PREFIX_NAME + "John Doe "
             + PREFIX_NAME + "Foo Bar "
+            + PREFIX_SESSION + "3 "
             + PREFIX_ATTENDANCE_PRESENCE + "present";
     public static final String MESSAGE_SUCCESS = "Attendance taken";
 

src/main/java/seedu/address/logic/commands/UpdateTaskProgressCommand.java

@@ -26,7 +26,7 @@ public class UpdateTaskProgressCommand extends Command {
     public static final String MESSAGE_USAGE = COMMAND_WORD
             + ": Updates the task's progress identified by the index number used in the displayed task list.\n"
             + "Parameters: "
-            + "INDEX (must be a positive integer) "
+            + "TASK_INDEX (must be a positive integer) "
             + PREFIX_TASK_PROGRESS + "PROGRESS\n"
             + "Example: " + COMMAND_WORD + " 1 " + PREFIX_TASK_PROGRESS + "PENDING";
 

src/main/java/seedu/address/logic/commands/ViewAttendanceCommand.java

@@ -26,7 +26,7 @@ public class ViewAttendanceCommand extends Command {
     public static final String COMMAND_WORD = "viewattendance";
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Views the attendance of a student. "
             + "Parameters: "
-            + "[" + PREFIX_NAME + "STUDENT_NAME]...\n"
+            + "[" + PREFIX_NAME + "NAME]...\n"
             + "Example: " + COMMAND_WORD + " "
             + PREFIX_NAME + "John Doe Alice";
 

src/main/java/seedu/address/logic/commands/ViewTasksCommand.java

@@ -28,9 +28,9 @@ public class ViewTasksCommand extends Command {
             + "Example: " + COMMAND_WORD
             + "[" + PREFIX_TASK_NAME + "cs2101 cs2100] "
             + "[" + PREFIX_TASK_DESCRIPTION + "homework assignment] "
+            + "[" + PREFIX_DATE + "22/10/2023] "
             + "[" + PREFIX_TASK_PRIORITY + "high] "
-            + "[" + PREFIX_TASK_PROGRESS + "pending] "
-            + "[" + PREFIX_DATE + "22/10/2023] ";
+            + "[" + PREFIX_TASK_PROGRESS + "pending] ";
 
     public static final CommandType COMMAND_TYPE = CommandType.VIEW_TASKS;