[CS2103T-T17-1] RHRH

docs/DeveloperGuide.md

@@ -118,7 +118,7 @@ How the parsing works:
 
 The `Model` component,
 
-* stores the address book data i.e., all `Customer`, `Employee`, `Supplier` and `Reservation` objects (which are contained in a `UniqueCustomerList`, `UniqueEmployeeList`, `UniqueSupplierList` and `UniqueReservationList` object respectively).
+* stores RHRH data i.e., all `Customer`, `Employee`, `Supplier` and `Reservation` objects (which are contained in a `UniqueCustomerList`, `UniqueEmployeeList`, `UniqueSupplierList` and `UniqueReservationList` object respectively).
 * stores the currently 'selected' `Customer`/`Employee`/`Supplier`/`Reservation` objects (e.g., results of a search query) as a separate _filtered_ list which is exposed to outsiders as an unmodifiable `ObservableList<Customer>`/`ObservableList<Employee>`/`ObservableList<Supplier>`/`ObservableList<Reservation>` respectively that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change.
 * stores a `UserPref` object that represents the user’s preferences. This is exposed to the outside as a `ReadOnlyUserPref` objects.
 * does not depend on any of the other three components (as the `Model` represents data entities of the domain, they should make sense on their own without depending on other components)
@@ -137,7 +137,7 @@ The `Model` component,
 <img src="images/StorageClassDiagram.png" width="550" />
 
 The `Storage` component,
-* can save both address book data and user preference data in json format, and read them back into corresponding objects.
+* can save both RHRH data and user preference data in json format, and read them back into corresponding objects.
 * inherits from both `RhrhStorage` and `UserPrefStorage`, which means it can be treated as either one (if only the functionality of only one is needed).
 * depends on some classes in the `Model` component (because the `Storage` component's job is to save/retrieve objects that belong to the `Model`)
 
@@ -516,31 +516,31 @@ display the reservations along with customer information.
 
 The proposed undo/redo mechanism is facilitated by `VersionedRhrh`. It extends `Rhrh` with an undo/redo history, stored internally as an `rhrhStateList` and `currentStatePointer`. Additionally, it implements the following operations:
 
-* `VersionedRhrh#commit()` — Saves the current address book state in its history.
-* `VersionedRhrh#undo()` — Restores the previous address book state from its history.
-* `VersionedRhrh#redo()` — Restores a previously undone address book state from its history.
+* `VersionedRhrh#commit()` — Saves the current RHRH state in its history.
+* `VersionedRhrh#undo()` — Restores the previous RHRH state from its history.
+* `VersionedRhrh#redo()` — Restores a previously undone RHRH state from its history.
 
 These operations are exposed in the `Model` interface as `Model#commitRhrh()`, `Model#undoRhrh()` and `Model#redoRhrh()` respectively.
 
 Given below is an example usage scenario and how the undo/redo mechanism behaves at each step.
 
-Step 1. The user launches the application for the first time. The `VersionedRhrh` will be initialized with the initial address book state, and the `currentStatePointer` pointing to that single address book state.
+Step 1. The user launches the application for the first time. The `VersionedRhrh` will be initialized with the initial RHRH state, and the `currentStatePointer` pointing to that single RHRH state.
 
 ![UndoRedoState0](images/UndoRedoState0.png)
 
-Step 2. The user executes `delete 5` command to delete the 5th person in the address book. The `delete` command calls `Model#commitRhrh()`, causing the modified state of the address book after the `delete 5` command executes to be saved in the `rhrhStateList`, and the `currentStatePointer` is shifted to the newly inserted address book state.
+Step 2. The user executes `delete 5` command to delete the 5th person in RHRH. The `delete` command calls `Model#commitRhrh()`, causing the modified state of RHRH after the `delete 5` command executes to be saved in the `rhrhStateList`, and the `currentStatePointer` is shifted to the newly inserted RHRH state.
 
 ![UndoRedoState1](images/UndoRedoState1.png)
 
-Step 3. The user executes `add n/David …​` to add a new person. The `add` command also calls `Model#commitRhrh()`, causing another modified address book state to be saved into the `rhrhStateList`.
+Step 3. The user executes `add n/David …​` to add a new person. The `add` command also calls `Model#commitRhrh()`, causing another modified RHRH state to be saved into the `rhrhStateList`.
 
 ![UndoRedoState2](images/UndoRedoState2.png)
 
-<div markdown="span" class="alert alert-info">:information_source: **Note:** If a command fails its execution, it will not call `Model#commitRhrh()`, so the address book state will not be saved into the `rhrhStateList`.
+<div markdown="span" class="alert alert-info">:information_source: **Note:** If a command fails its execution, it will not call `Model#commitRhrh()`, so RHRH state will not be saved into the `rhrhStateList`.
 
 </div>
 
-Step 4. The user now decides that adding the person was a mistake, and decides to undo that action by executing the `undo` command. The `undo` command will call `Model#undoRhrh()`, which will shift the `currentStatePointer` once to the left, pointing it to the previous address book state, and restores the address book to that state.
+Step 4. The user now decides that adding the person was a mistake, and decides to undo that action by executing the `undo` command. The `undo` command will call `Model#undoRhrh()`, which will shift the `currentStatePointer` once to the left, pointing it to the previous RHRH state, and restores RHRH to that state.
 
 ![UndoRedoState3](images/UndoRedoState3.png)
 
@@ -557,17 +557,17 @@ The following sequence diagram shows how the undo operation works:
 
 </div>
 
-The `redo` command does the opposite — it calls `Model#redoRhrh()`, which shifts the `currentStatePointer` once to the right, pointing to the previously undone state, and restores the address book to that state.
+The `redo` command does the opposite — it calls `Model#redoRhrh()`, which shifts the `currentStatePointer` once to the right, pointing to the previously undone state, and restores RHRH to that state.
 
-<div markdown="span" class="alert alert-info">:information_source: **Note:** If the `currentStatePointer` is at index `rhrhStateList.size() - 1`, pointing to the latest address book state, then there are no undone Rhrh states to restore. The `redo` command uses `Model#canRedoRhrh()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.
+<div markdown="span" class="alert alert-info">:information_source: **Note:** If the `currentStatePointer` is at index `rhrhStateList.size() - 1`, pointing to the latest RHRH state, then there are no undone Rhrh states to restore. The `redo` command uses `Model#canRedoRhrh()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.
 
 </div>
 
-Step 5. The user then decides to execute the command `list`. Commands that do not modify the address book, such as `list`, will usually not call `Model#commitRhrh()`, `Model#undoRhrh()` or `Model#redoRhrh()`. Thus, the `rhrhStateList` remains unchanged.
+Step 5. The user then decides to execute the command `list`. Commands that do not modify RHRH, such as `list`, will usually not call `Model#commitRhrh()`, `Model#undoRhrh()` or `Model#redoRhrh()`. Thus, the `rhrhStateList` remains unchanged.
 
 ![UndoRedoState4](images/UndoRedoState4.png)
 
-Step 6. The user executes `clear`, which calls `Model#commitRhrh()`. Since the `currentStatePointer` is not pointing at the end of the `rhrhStateList`, all address book states after the `currentStatePointer` will be purged. Reason: It no longer makes sense to redo the `add n/David …​` command. This is the behavior that most modern desktop applications follow.
+Step 6. The user executes `clear`, which calls `Model#commitRhrh()`. Since the `currentStatePointer` is not pointing at the end of the `rhrhStateList`, all RHRH states after the `currentStatePointer` will be purged. Reason: It no longer makes sense to redo the `add n/David …​` command. This is the behavior that most modern desktop applications follow.
 
 ![UndoRedoState5](images/UndoRedoState5.png)
 
@@ -579,7 +579,7 @@ The following activity diagram summarizes what happens when a user executes a ne
 
 **Aspect: How undo & redo executes:**
 
-* **Alternative 1 (current choice):** Saves the entire address book.
+* **Alternative 1 (current choice):** Saves the entire RHRH.
   * Pros: Easy to implement.
   * Cons: May have performance issues in terms of memory usage.
 

docs/UserGuide.md

@@ -66,7 +66,6 @@ Dangerous or potentially negative actions are displayed here
     - Format: `addC n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS lp/LOYALTYPOINTS [alg/ALLERGIES] [sr/SPECIAL_REQUESTS] [t/TAG]...`
     - Example: `addC n/John Doe p/87654321 e/e12345@u.nus.edu a/Clementi lp/1000`
 
-
 6. Refer to the [Features](#features) below for details of each command. If you want to have an overview of all the commands, you can refer to [Command Summary](#command-summary) section.
 
 ### Command syntax

docs/diagrams/AddEmployeeCommandSequenceDiagram.puml

@@ -28,7 +28,7 @@ activate addEmployeeCommandParser
 addEmployeeCommandParser --[LOGIC_COLOR]> rhrhParser
 deactivate addEmployeeCommandParser
 
-rhrhParser -[LOGIC_COLOR]> addEmployeeCommandParser :"parse(n/John Doe...)"
+rhrhParser -[LOGIC_COLOR]> addEmployeeCommandParser :parse(n/John Doe...)
 activate addEmployeeCommandParser
 
 create command

docs/team/chetwinlow.md

@@ -43,7 +43,7 @@ restaurants.
 * Implemented logic for earlier iterations of [`Find`](https://github.com/AY2122S1-CS2103T-T17-1/tp/pull/98) command.
 
 #### Review and Mentoring contributions
-* PRs reviewed with comments(non-exhaustive): PRs [\#191](https://github.com/AY2122S1-CS2103T-T17-1/tp/pull/191), 
+* PRs reviewed with comments(non-exhaustive): PRs [\#227](https://github.com/AY2122S1-CS2103T-T17-1/tp/pull/227), [\#191](https://github.com/AY2122S1-CS2103T-T17-1/tp/pull/191), 
       [\#99](https://github.com/AY2122S1-CS2103T-T17-1/tp/pull/99), [\#92](https://github.com/AY2122S1-CS2103T-T17-1/tp/pull/92)
 
 #### Contributions beyond the team project

docs/team/clementkfj.md

@@ -44,7 +44,7 @@ Given below are my contributions to the project.
     * Improve `Find` Employees command to search more accurately for `Shift` (Pull request [\#131](https://github.com/AY2122S1-CS2103T-T17-1/tp/pull/131))
     * Improve `Find` Suppliers and Customers command to search more accurately (Pull request [\#131](https://github.com/AY2122S1-CS2103T-T17-1/tp/pull/131))
     * Fix PE-D related bugs, changing validity checkers to enforce stricter rules for entering fields so people will not find bugs in it (Issues [\#154](https://github.com/AY2122S1-CS2103T-T17-1/tp/issues/154), [\#155](https://github.com/AY2122S1-CS2103T-T17-1/tp/issues/155) and [\#162](https://github.com/AY2122S1-CS2103T-T17-1/tp/issues/162), Pull request [\#177](https://github.com/AY2122S1-CS2103T-T17-1/tp/pull/177))
-    * Removed all instances of Address Book in RHRH (Pull requests [\#201](https://github.com/AY2122S1-CS2103T-T17-1/tp/pull/201))
+    * Removed all instances of address book in RHRH (Pull requests [\#201](https://github.com/AY2122S1-CS2103T-T17-1/tp/pull/201))
 
 * **Documentation**:
     * User Guide:

docs/team/johndoe.md

@@ -5,7 +5,7 @@ title: John Doe's Project Portfolio Page
 
 ### Project: Rhrh Level 3
 
-Rhrh - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+Rhrh - Level 3 is a desktop RHRH application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
 
 Given below are my contributions to the project.
 

docs/tutorials/AddRemark.md

@@ -5,7 +5,7 @@ title: "Tutorial: Adding a command"
 
 Let's walk you through the implementation of a new command — `remark`.
 
-This command allows users of the Rhrh application to add optional remarks to people in their address book and edit it if required. The command should have the following format:
+This command allows users of the Rhrh application to add optional remarks to people in their RHRH and edit it if required. The command should have the following format:
 
 `remark INDEX r/REMARK` (e.g., `remark 2 r/Likes baseball`)
 
@@ -28,7 +28,7 @@ package seedu.address.logic.commands;
 import seedu.address.model.Model;
 
 /**
- * Changes the remark of an existing person in the address book.
+ * Changes the remark of an existing person in RHRH.
  */
 public class RemarkCommand extends Command {
 
@@ -295,7 +295,7 @@ While the changes to code may be minimal, the test data will have to be updated
 
 <div markdown="span" class="alert alert-warning">
 
-:exclamation: You must delete Rhrh’s storage file located at `/data/addressbook.json` before running it! Not doing so will cause Rhrh to default to an empty address book!
+:exclamation: You must delete Rhrh’s storage file located at `/data/addressbook.json` before running it! Not doing so will cause Rhrh to default to an empty RHRH!
 
 </div>
 

docs/tutorials/TracingCode.md

@@ -292,10 +292,10 @@ Here are some quick questions you can try to answer based on your execution path
 
     2.  Allow `delete` to remove more than one index at a time
 
-    3.  Save the address book in the CSV format instead
+    3.  Save RHRH in the CSV format instead
 
     4.  Add a new command
 
     5.  Add a new field to `Person`
 
-    6.  Add a new entity to the address book
+    6.  Add a new entity to RHRH

src/main/java/seedu/address/MainApp.java

@@ -69,9 +69,9 @@ public void init() throws Exception {
     }
 
     /**
-     * Returns a {@code ModelManager} with the data from {@code storage}'s address book and {@code userPrefs}. <br>
-     * The data from the sample address book will be used instead if {@code storage}'s address book is not found,
-     * or an empty address book will be used instead if errors occur when reading {@code storage}'s address book.
+     * Returns a {@code ModelManager} with the data from {@code storage}'s RHRH and {@code userPrefs}. <br>
+     * The data from the sample RHRH will be used instead if {@code storage}'s RHRH is not found,
+     * or an empty RHRH will be used instead if errors occur when reading {@code storage}'s RHRH.
      */
     private Model initModelManager(Storage storage, ReadOnlyUserPrefs userPrefs) {
         Optional<ReadOnlyRhrh> rhrhOptional;
@@ -173,7 +173,7 @@ public void start(Stage primaryStage) {
 
     @Override
     public void stop() {
-        logger.info("============================ [ Stopping Address Book ] =============================");
+        logger.info("============================ [ Stopping RHRH ] =============================");
         try {
             storage.saveUserPrefs(model.getUserPrefs());
         } catch (IOException e) {

src/main/java/seedu/address/logic/Logic.java

@@ -45,7 +45,7 @@ public interface Logic {
     ObservableList<Reservation> getFilteredReservations();
 
     /**
-     * Returns the user prefs' address book file path.
+     * Returns the user prefs' RHRH file path.
      */
     Path getRhrhFilePath();
 

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

@@ -20,7 +20,7 @@ public class AddCustomerCommand extends Command {
     public static final String COMMAND_WORD = "addc";
 
     public static final String MESSAGE_USAGE = CommandUtil.formatCommandWord(COMMAND_WORD)
-            + ": Adds a customer to the address book. "
+            + ": Adds a customer to RHRH. "
             + "Parameters: "
             + PREFIX_NAME + "NAME "
             + PREFIX_PHONE + "PHONE "

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

@@ -17,13 +17,13 @@
 import seedu.address.model.person.employee.Employee;
 
 /**
- * Adds an employee to the address book.
+ * Adds an employee to RHRH.
  */
 public class AddEmployeeCommand extends Command {
     public static final String COMMAND_WORD = "adde";
 
     public static final String MESSAGE_USAGE = CommandUtil.formatCommandWord(COMMAND_WORD)
-            + ": Adds an employee to the address book. "
+            + ": Adds an employee to RHRH. "
             + "Parameters: "
             + PREFIX_NAME + "NAME "
             + PREFIX_PHONE + "PHONE "
@@ -46,7 +46,7 @@ public class AddEmployeeCommand extends Command {
             + PREFIX_TAG + "Team C";
 
     public static final String MESSAGE_SUCCESS = "New employee has been added: %1$s";
-    public static final String MESSAGE_DUPLICATE_EMPLOYEE = "Employee information already exists in the address book";
+    public static final String MESSAGE_DUPLICATE_EMPLOYEE = "Employee information already exists in RHRH";
 
     private final Employee toAdd;
 

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

@@ -15,13 +15,13 @@
 import seedu.address.model.person.supplier.Supplier;
 
 /**
- * Adds a supplier to the address book.
+ * Adds a supplier to RHRH.
  */
 public class AddSupplierCommand extends Command {
     public static final String COMMAND_WORD = "adds";
 
     public static final String MESSAGE_USAGE = CommandUtil.formatCommandWord(COMMAND_WORD)
-            + ": Adds a person to the address book. "
+            + ": Adds a person to RHRH. "
             + "Parameters: "
             + PREFIX_NAME + "NAME "
             + PREFIX_PHONE + "PHONE "
@@ -41,7 +41,7 @@ public class AddSupplierCommand extends Command {
             + PREFIX_DELIVERY_DETAILS + "12:00 10-11-2021";
 
     public static final String MESSAGE_SUCCESS = "New supplier added: %1$s";
-    public static final String MESSAGE_DUPLICATE_SUPPLIER = "This supplier already exists in the address book";
+    public static final String MESSAGE_DUPLICATE_SUPPLIER = "This supplier already exists in RHRH";
 
     private final Supplier toAdd;
 

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

@@ -6,7 +6,7 @@
 import seedu.address.model.Rhrh;
 
 /**
- * Clears the address book.
+ * Clears RHRH.
  */
 public class ClearCommand extends Command {
 

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

@@ -12,7 +12,7 @@
 import seedu.address.model.person.customer.Customer;
 
 /**
- * Deletes a customer identified using it's displayed index from the address book.
+ * Deletes a customer identified using it's displayed index from RHRH.
  */
 public class DeleteCustomerCommand extends Command {
 

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

@@ -12,7 +12,7 @@
 import seedu.address.model.person.employee.Employee;
 
 /**
- * Deletes an employee identified using it's displayed index from the address book.
+ * Deletes an employee identified using it's displayed index from RHRH.
  */
 public class DeleteEmployeeCommand extends Command {
 

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

@@ -12,7 +12,7 @@
 import seedu.address.model.reservation.Reservation;
 
 /**
- * Deletes a reservation identified using it's displayed index from the address book.
+ * Deletes a reservation identified using it's displayed index from RHRH.
  */
 public class DeleteReservationCommand extends Command {
 

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

@@ -12,7 +12,7 @@
 import seedu.address.model.person.supplier.Supplier;
 
 /**
- * Deletes a supplier identified using it's displayed index from the address book.
+ * Deletes a supplier identified using it's displayed index from RHRH.
  */
 public class DeleteSupplierCommand extends Command {
 

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

@@ -35,7 +35,7 @@
 
 
 /**
- * Edits the details of an existing customer in the address book.
+ * Edits the details of an existing customer in RHRH.
  */
 public class EditCustomerCommand extends Command {
     public static final String COMMAND_WORD = "editc";
@@ -67,6 +67,8 @@ public class EditCustomerCommand extends Command {
     private final EditCustomerDescriptor editCustomerDescriptor;
 
     /**
+     * Constructs an EditCustomerCommand to edit the customer at {@code Index}
+     *
      * @param index of the customer in the filtered customer list to edit
      * @param editCustomerDescriptor details to edit the customer with
      */