Skip to content

Commit

Permalink
Fix checkstyle
Browse files Browse the repository at this point in the history
  • Loading branch information
tanveersingh10 committed Nov 13, 2023
1 parent 3831c5e commit a0fa41d
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 34 deletions.
28 changes: 14 additions & 14 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ The following sequence diagram shows how the add patient works:
### Edit Patient/Doctor Feature

This feature allows users to edit patients or doctors to the address book. The person must already
exist in the address book. There are many fields for each patient/doctor to be
exist in the address book. There are many fields for each patient/doctor to be
edited which can be found in the user guide.

#### Implementation
Expand All @@ -286,7 +286,7 @@ Step 4. Then `editCommandParser` parses the remaining arguments and creates an `
details of the patient given.

:information_source: **Note:** If the details of the person added does not match the correct format for any fields,
there will be an error telling user that the attributes are in the wrong format. Also, if there are no attributes passed there will be an error.
there will be an error telling user that the attributes are in the wrong format. Also, if there are no attributes passed there will be an error.
It's ok if the attributes are the same as the original attributes.
Lastly, an NRIC must be provided and if the nric cannot be found within the list of doctors and patients, there will be an error.

Expand All @@ -303,19 +303,19 @@ The following sequence diagram shows how the add patient works:
### Design Considerations

1. Option 1 (Current Choice): Use a single EditCommand for both doctors and patients
- Pros: Easier for the user. Can use a single command to edit both.
- Pros: Easier for the user. Can use a single command to edit both.
- Cons: The program has to check whether the person is a doctor or patient. This mandates that a person cannot
be both a patient as a doctor, as patients have additional attributes. The program also might be slightly slower
since it has to check through both the doctors and patients list to locate the person.
2. Option 2: Use 2 commands edit-patient and edit-doctor
- Pros: The program might be faster. If you call edit-doctor you only need to search through a few doctors
rather than all the patients as well.
- Cons: Harder to implement, and there's a need to create new classes and add repeated code.
- Cons: Harder to implement, and there's a need to create new classes and add repeated code.
More commands for the user to remember as well.

### Delete Patient/Doctor Feature

This feature allows users to delete the desired patient or doctor based on the
This feature allows users to delete the desired patient or doctor based on the
nric provided.

#### Implementation
Expand All @@ -325,18 +325,18 @@ of Index.

Given below is an example usage scenario and how the delete mechanism behaves at each step.

Step 1. The user launches the application for the first time. The AddressBook will be initialized with the initial
Step 1. The user launches the application for the first time. The AddressBook will be initialized with the initial
address book state.

Step 2. The user populates the AddressBook with patients and doctors using the appropriate commands, if not already
Step 2. The user populates the AddressBook with patients and doctors using the appropriate commands, if not already
done.

Step 3. The user types `delete` as the command, with the appropriate nric of the patient/doctor to be deleted, for
Step 3. The user types `delete` as the command, with the appropriate nric of the patient/doctor to be deleted, for
example `delete S9567312G`.

Step 4. The `deleteCommandParser` parses the delete command and creates a `deleteCommand` with the target Ic.

Step 5. The PatientCard / DoctorCard then processes the deletion and The UI should display the updated list without the
Step 5. The PatientCard / DoctorCard then processes the deletion and The UI should display the updated list without the
deleted Doctor/Patient.

### Create New Appointment Feature
Expand Down Expand Up @@ -522,7 +522,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
| `* * *` | Hospital Staff | delete a patient/doctor | remove entries that I no longer need |
| `* * *` | Hospital Staff | add an appointment | tell which patient/doctor is coming at what time |
| `* * *` | Hospital Staff | update patient's details | information remains accurate |
| `* * *` | Hospital Staff | update doctor's details | information remains accurate |
| `* * *` | Hospital Staff | update doctor's details | information remains accurate |
| `* * *` | Hospital Staff | find a patient/doctor by NRIC | locate details of persons without having to go through the entire list |
| `* * *` | Hospital Staff | reassign patients to doctors/nurses | account for changes in the people treating the patients |
| `* *` | Hospital Staff | hide private contact details | minimize chance of someone else seeing them by accident |
Expand Down Expand Up @@ -591,7 +591,7 @@ otherwise)
**Extensions**

* 1a. No person with matching attribute found.
* 1a1. Medilink Contacts lists 0 persons.
* 1a1. Medilink Contacts lists 0 persons.

Use case ends.

Expand All @@ -617,14 +617,14 @@ otherwise)
* 3a1. Medilink Contacts shows an error message.

Use case resumes at step 2.

* 4a. There are no edited fields, i.e. either no fields provided or new fields are the same as the previous ones

* 4a1. Medilink Contacts shows an error message.

Use case resumes at step 2.

* 4b. The edited fields include invalid inputs.
* 4b. The edited fields include invalid inputs.

* 4b1. Medilink Contacts shows an error message.

Expand Down
24 changes: 12 additions & 12 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ The list below contains the parameters that are used in various commands as well
* Parameters can be in any order.<br>
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.

* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit`,
* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit`,
`clear`, `undo` and `redo`) will be
ignored.<br>
e.g. if the command specifies `help 123`, it will be interpreted as `help`.
Expand Down Expand Up @@ -154,21 +154,21 @@ Error Message: `Invalid command format!` <br>
`add-doctor: Adds a person to MediLink Contacts. Parameters: n/NAME p/PHONE e/EMAIL a/ADDRESS g/GENDER ic/NRIC [t/TAG]...`
2. Invalid/Empty Field <br>
Fields have specific formats to be followed. Failure to adhere to this format will lead to an error message
that specifies the format to be used for that field. Usage of flags without any message will lead to the same
that specifies the format to be used for that field. Usage of flags without any message will lead to the same
corresponding error message since no field supports empty inputs.
```
add-doctor n/ ic/S9851586G g/F p/98765433 e/betsycrowe@example.com a/#104-C, Wakanda St 42 t/Surgeon
Names should only contain alphanumeric characters and spaces, and it should not be blank
add-doctor n/Betsy Crowe ic/999 g/F p/98765433 e/betsycrowe@example.com a/#104-C, Wakanda St 42 t/Surgeon
Ic should start with S or T, followed by 7 numbers, and ends with a letter. Letters inputs are case-insensitive. Empty strings are not allowed
add-doctor n/Betsy Crowe ic/S9851586G g/B p/98765433 e/betsycrowe@example.com a/#104-C, Wakanda St 42 t/Surgeon
Gender should only be M for Male or F for Female
Gender should only be M for Male or F for Female
add-doctor n/Betsy Crowe ic/S9851586G g/F p/phoneNumber e/betsycrowe@example.com a/#104-C, Wakanda St 42 t/Surgeon
Phone numbers should only contain numbers, and it should be at least 3 digits long
add-doctor n/Betsy Crowe ic/S9851586G g/F p/98765433 e/ a/#104-C, Wakanda St 42 t/Surgeon
Emails should be of the format local-part@domain and adhere to the following constraints:
1. The local-part should only contain alphanumeric characters and these special characters, excluding the parentheses, (+_.-). The local-part may not start or end with any special characters.
Expand All @@ -177,10 +177,10 @@ corresponding error message since no field supports empty inputs.
- end with a domain label at least 2 characters long
- have each domain label start and end with alphanumeric characters
- have each domain label consist of alphanumeric characters, separated only by hyphens, if any.
add-doctor n/Betsy Crowe ic/S9851586G g/F p/98765433 e/betsycrowe@example.com a/ t/Surgeon
Addresses can take any values, and it should not be blank
add-doctor n/Betsy Crowe ic/S9851586G g/F p/98765433 e/betsycrowe@example.com a/#104-C, Wakanda St 42 t/BestDoctor
Doctor tag should be a valid specialisation.
```
Expand Down Expand Up @@ -308,7 +308,7 @@ Format: `edit NRIC [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
* If the provided fields are the same as the original, the command will still work.
* You cannot change a person's IC number. If the provided ic number is the same as the original it will work.
However, if it is different, there will be an error.
* Must edit appropriate fields based on whether the person is a patient or doctor (e.g. can't update condition, blood type or
* Must edit appropriate fields based on whether the person is a patient or doctor (e.g. can't update condition, blood type or
emergency contact of a doctor).
* Existing values will be updated to the input values.g
* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
Expand Down Expand Up @@ -377,7 +377,7 @@ Examples:

Finds all Patients with query blood type.

Format: `find Blood Type QUERY`
Format: `find Blood Type QUERY`

* It is recommended to use `list` to restore the view of all data after a `find` command.

Expand Down Expand Up @@ -436,7 +436,7 @@ Format: `undo`

</div>

Restores the effects of actions that were previously undone using the undo command.
Restores the effects of actions that were previously undone using the undo command.

Format: `redo`

Expand Down
2 changes: 1 addition & 1 deletion docs/diagrams/EditSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,4 @@ deactivate EditCommand
deactivate LogicManager


@enduml
@enduml
4 changes: 2 additions & 2 deletions docs/team/chonguschonguschongus.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Given below are my contributions to the project.
* **New Feature**: Enhanced the Find feature to function with NRIC, blood type, gender as well as name.
* What it does: Allows users to search for Patients/Doctors by their NRIC, blood type, gender or simply name
* Justification: Users can search by a specific attribute, increasing convenience

* **New Feature**: Added a Find Appointment function to locate a specific appointment by NRIC of people involved
* **New Feature** Added a Delete Appointment function to delete a specific appointment by NRIC of people involved

Expand All @@ -26,7 +26,7 @@ Given below are my contributions to the project.
* Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub

* **Enhancements to existing features**:
* Wrote an abstract UniqueObjectList that can be inherited to form UniqueLists of Patients, Doctors and Appointments
* Wrote an abstract UniqueObjectList that can be inherited to form UniqueLists of Patients, Doctors and Appointments
* Updated the GUI color scheme (Pull requests [\#33](), [\#34]())
* Wrote additional tests for existing features (Pull requests [\#36](), [\#38]())

Expand Down
6 changes: 3 additions & 3 deletions docs/team/cmhuang777.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Given below are my contributions to the project.

* **New Feature**: Modified current add person command to add new Patient class
* **New Feature**: Added new command and parser to add new appointment for patients and doctors
* Also updated the storage for the appointments
* Also updated the storage for the appointments
* **New Feature**: Created a new Class AppointmentTime to represent the time object used in Appointment
* **New Feature**: Updated part of the sample data to include the new features

Expand All @@ -34,10 +34,10 @@ Given below are my contributions to the project.
* (to be added soon)

* **Documentation**:
* User Guide:
* User Guide:
* Updated existing content to our project
* Added the section on adding new patients
* Developer Guide:
* Developer Guide:
* Included the section for add patient/doctor feature and added a new sequence diagram for that feature
* Added use case for adding new patient

Expand Down
2 changes: 1 addition & 1 deletion docs/team/kohkaijie.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: Kai Jie's Project Portfolio Page
MediLink Contacts aims to help medical staff including nurses/doctors/pharmacists navigate through patient details in
their high workload and time-pressured working environment. When medical emergencies arise, it becomes crucial to
provide rapid access to emergency contacts for patients and access other details of the patients to make decisions more
quickly. It is optimised for CLI so that users can quickly access the information. There is also a GUI created with
quickly. It is optimised for CLI so that users can quickly access the information. There is also a GUI created with
JavaFX.

Given below are my contributions to the project.
Expand Down
2 changes: 1 addition & 1 deletion docs/team/tanveersingh10.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Given below are my contributions to the project.

* **New Feature**: Implemented the Edit Command
* What it does: allows to update fields of a doctor or patient.
* Justification: This feature improves the product significantly because a user can make mistakes and may need to change details of a person. Alternatively, it's possible a
* Justification: This feature improves the product significantly because a user can make mistakes and may need to change details of a person. Alternatively, it's possible a
person's details change over time, such as their condition or remarks, and there needs to be a quick way to update the information.

* **Project management**:
Expand Down

0 comments on commit a0fa41d

Please sign in to comment.