From 348e38602b4593d5e46057c58fe862f095bf5b0b Mon Sep 17 00:00:00 2001 From: MGRL2201 Date: Thu, 14 Oct 2021 00:10:28 +0800 Subject: [PATCH 1/2] 1. update UG 2. update build.gradle 3. update exception messages --- build.gradle | 2 +- docs/UserGuide.md | 31 ++++++++++--------- .../logic/commands/EnrollCommand.java | 2 +- .../logic/commands/UnenrollCommand.java | 2 +- .../seedu/tuitione/model/lesson/Subject.java | 2 +- .../seedu/tuitione/model/student/Grade.java | 2 +- 6 files changed, 21 insertions(+), 20 deletions(-) diff --git a/build.gradle b/build.gradle index a8137bea66e..45e53d229bb 100644 --- a/build.gradle +++ b/build.gradle @@ -66,7 +66,7 @@ dependencies { } shadowJar { - archiveName = 'addressbook.jar' + archiveName = 'TuitiONE.jar' } defaultTasks 'clean', 'test' diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 5f32e845f91..0a18a14a4f5 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -9,35 +9,35 @@ If you can type fast, TuitiONE can get your contact management tasks done faster * Table of Contents {:toc} -[comment]: <> (--------------------------------------------------------------------------------------------------------------------) +-------------------------------------------------------------------------------------------------------------------- -[comment]: <> (## Quick start) +## Quick start -[comment]: <> (1. Ensure you have Java `11` or above installed in your Computer.) +1. Ensure you have Java `11` or above installed in your Computer. -[comment]: <> (1. Download the latest `TuitiONE.jar` from [here](https://github.com/AY2122S1-CS2103T-F13-4/tp/releases).) +1. Download the latest `TuitiONE.jar` from [here](https://github.com/AY2122S1-CS2103T-F13-4/tp/releases). -[comment]: <> (1. Copy the file to the folder you want to use as the _home folder_ for your TuitiONE.) +1. Copy the file to the folder you want to use as the _home folder_ for your TuitiONE. -[comment]: <> (1. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
) +1. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. _Note how the app contains some sample data_.
-[comment]: <> ( ![Ui](images/Ui.png)) + ![Ui](images/Ui.png) -[comment]: <> (1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
) +1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
-[comment]: <> ( Some example commands you can try:) + Some example commands you can try: -[comment]: <> ( * **`list`** : Lists all contacts.) + * **`list`** : Lists all students. -[comment]: <> ( * **`add`**`n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book.) + * **`add`**`n/John Doe p/98765432 e/jd@gmail.com a/John street, block 123, #01-01 g/P2` : Adds a student named `John Doe` to the TuitiONE app. -[comment]: <> ( * **`delete`**`3` : Deletes the 3rd contact shown in the current list.) + * **`delete`**`3` : Deletes the 3rd student shown in the student list. -[comment]: <> ( * **`clear`** : Deletes all contacts.) + * **`clear`** : Deletes all data (students and lessons). -[comment]: <> ( * **`exit`** : Exits the app.) + * **`exit`** : Exits the app. -[comment]: <> (1. Refer to the [Features](#features) below for details of each command.) +1. Refer to the [Features](#features) below for details of each command. -------------------------------------------------------------------------------------------------------------------- @@ -240,3 +240,4 @@ Action | Format, Examples **Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g. `find James Jake` **List** | `list` **Help** | `help` +**Exit** | `exit` diff --git a/src/main/java/seedu/tuitione/logic/commands/EnrollCommand.java b/src/main/java/seedu/tuitione/logic/commands/EnrollCommand.java index 9b523bccb4d..2ff717a89f7 100644 --- a/src/main/java/seedu/tuitione/logic/commands/EnrollCommand.java +++ b/src/main/java/seedu/tuitione/logic/commands/EnrollCommand.java @@ -23,7 +23,7 @@ public class EnrollCommand extends Command { public static final String MESSAGE_USAGE = COMMAND_WORD + ": Enrolls a specified student " + "from a given TuitiONE lesson\n" + "Parameters: INDEX (must be a positive integer) " - + "LESSON_CODE\n" + + "l/LESSON_CODE\n" + "Example: " + "enroll 1 " + PREFIX_LESSON + "Science-P5-Wed-1230"; public static final String MESSAGE_STUDENT_IN_LESSON = "%1$s is already enrolled in the existing %2$s"; diff --git a/src/main/java/seedu/tuitione/logic/commands/UnenrollCommand.java b/src/main/java/seedu/tuitione/logic/commands/UnenrollCommand.java index 4fc671b13ec..603bfceaeeb 100644 --- a/src/main/java/seedu/tuitione/logic/commands/UnenrollCommand.java +++ b/src/main/java/seedu/tuitione/logic/commands/UnenrollCommand.java @@ -26,7 +26,7 @@ public class UnenrollCommand extends Command { public static final String MESSAGE_USAGE = COMMAND_WORD + ": Unenroll a specified student " + "from a given TuitiONE lesson\n" + "Parameters: INDEX (must be a positive integer) " - + "LESSON_CODE\n" + + "l/LESSON_CODE\n" + "Example: " + "unenroll 1 " + PREFIX_LESSON + "Science-P5-Wed-1230"; public static final String MESSAGE_UNENROLL_STUDENT_SUCCESS = "Unenrolled Student: %1$s from Lesson: %2$s"; diff --git a/src/main/java/seedu/tuitione/model/lesson/Subject.java b/src/main/java/seedu/tuitione/model/lesson/Subject.java index a4772a6c126..e493ee09896 100644 --- a/src/main/java/seedu/tuitione/model/lesson/Subject.java +++ b/src/main/java/seedu/tuitione/model/lesson/Subject.java @@ -12,7 +12,7 @@ public class Subject { public static final String SUBJECT_VALIDATION_REGEX = "\\p{Alnum}+"; public static final int MAXIMUM_SUBJECT_LENGTH = 20; public static final String SUBJECT_MESSAGE_CONSTRAINTS = String.format("Subject names should be alphanumeric and" - + "within %1$d characters", MAXIMUM_SUBJECT_LENGTH); + + " within %1$d characters", MAXIMUM_SUBJECT_LENGTH); public final String value; diff --git a/src/main/java/seedu/tuitione/model/student/Grade.java b/src/main/java/seedu/tuitione/model/student/Grade.java index 8320150b27a..63f8ccec582 100644 --- a/src/main/java/seedu/tuitione/model/student/Grade.java +++ b/src/main/java/seedu/tuitione/model/student/Grade.java @@ -10,7 +10,7 @@ */ public class Grade { public static final String GRADE_MESSAGE_CONSTRAINTS = "Prefix should either be S (to denote secondary) " - + "or P (to denote Primary)." + + "or P (to denote Primary). " + "Level number should be from 1 to 6 for primary and 1 to 4 for secondary."; public static final String[] VALID_GRADES = {"P1", "P2", "P3", "P4", "P5", "P6", "S1", "S2", "S3", "S4"}; From e814490ffa3dfd87618f65ca9cf429345d51291c Mon Sep 17 00:00:00 2001 From: MGRL2201 Date: Thu, 14 Oct 2021 00:22:25 +0800 Subject: [PATCH 2/2] 1. fix formating issues --- src/main/java/seedu/tuitione/ui/LessonCard.java | 2 +- src/main/java/seedu/tuitione/ui/StudentCard.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/seedu/tuitione/ui/LessonCard.java b/src/main/java/seedu/tuitione/ui/LessonCard.java index cd406ff16d0..b024292d19b 100644 --- a/src/main/java/seedu/tuitione/ui/LessonCard.java +++ b/src/main/java/seedu/tuitione/ui/LessonCard.java @@ -17,7 +17,7 @@ public class LessonCard extends UiPart { private static final String FXML = "LessonListCard.fxml"; private static final String STRING_FORMAT_SUBJECT = "Subject: \t%s"; private static final String STRING_FORMAT_GRADE = "Grade: \t%s"; - private static final String STRING_FORMAT_DAY = "Day: \t\t%s"; + private static final String STRING_FORMAT_DAY = "Day: \t%s"; private static final String STRING_FORMAT_TIME = "Time: \t%s - %s"; private static final String STRING_FORMAT_PRICE = "Price: \t%s"; /** diff --git a/src/main/java/seedu/tuitione/ui/StudentCard.java b/src/main/java/seedu/tuitione/ui/StudentCard.java index 49dbe7c9d1d..4da81a022b3 100644 --- a/src/main/java/seedu/tuitione/ui/StudentCard.java +++ b/src/main/java/seedu/tuitione/ui/StudentCard.java @@ -17,7 +17,7 @@ public class StudentCard extends UiPart { private static final String FXML = "StudentListCard.fxml"; private static final String STRING_FORMAT_PARENT_CONTACT = "Parent's Contact: \t%s"; - private static final String STRING_FORMAT_ADDRESS = "Address: \t\t\t%s"; + private static final String STRING_FORMAT_ADDRESS = "Address: \t\t%s"; private static final String STRING_FORMAT_EMAIL = "Email Address: \t%s"; private static final String STRING_FORMAT_GRADE = "Grade: \t\t\t%s"; private static final String STRING_FORMAT_LESSON = "Lesson(s): \t";