Skip to content

Commit fb5325b

Browse files
committed
Update a few format and style errors in the Developer gudie
1 parent 46ca568 commit fb5325b

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

docs/DeveloperGuide.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -643,8 +643,8 @@ Priorities: High (must have) - `* * *`, Medium (Good to have) - `* *`, Low (nice
643643

644644
* **Archive**: A feature that allows users to store old data for use later without cluttering the current interface.
645645
* **Export**: Saving the student data in a file format as `json` file. This is done through data archiving.
646-
* **Private contact detail**: A contact detail that is not meant to be shared with others
647-
* **Mainstream OS**: Windows, Linux, Unix, MacOS
646+
* **Private contact detail**: A contact detail that is not meant to be shared with others.
647+
* **Mainstream OS**: Windows, Linux, Unix, MacOS.
648648
* **Student Number**: A unique identifier assigned to each student.
649649
* **Tag**: A label that can be added to a student for categorization or searching.
650650
* **Undo/Redo**: The ability to reverse an action/command made in the application.
@@ -680,7 +680,7 @@ testers are expected to do more *exploratory* testing.
680680

681681
### Adding a person
682682
1. Adding a person into the person list
683-
1. Assumption: We assume there is no duplicate in this test case
683+
1. Assumption: We assume there is no duplicate in this test case
684684
2. Test case `add n/John Doe p/98765432 g/male m/Physics`<br>
685685
Expected: A person named John Doe into StoreClass with the details givens
686686
3. Test case `add n/John Doe p/000 g/male m/Physics`<br>
@@ -726,29 +726,29 @@ testers are expected to do more *exploratory* testing.
726726
### Saving data
727727

728728
1. Dealing with missing/corrupted data files
729-
1. Here `<HomeFolder>` refer to the folder containing the jar file.
729+
1. Here `<HomeFolder>` refer to the folder containing the jar file.
730730
1. Test case: Missing data file<br>
731731
1. Close the app
732732
2. Delete the json file with path `<HomeFolder>/data/addressbook.json` or remove the `data` folder entirely
733733
3. Reopen the app <br>
734-
Expected: a sample database will be provided.
734+
Expected: a sample database will be provided.
735735
2. Test case: Corrupted file<br>
736736
1. Ensure that there is at least 1 student in StoreClass
737737
1. Close the app
738738
2. Open the json file with path `<HomeFolder>/data/addressbook.json` and edit the name of the first student name to a invalid one e.g. `J@hn D*n`
739739
3. ReOpen the app <br>
740-
Expected: the corrupted list is discarded and an empty list is provided
740+
Expected: the corrupted list is discarded and an empty list is provided.
741741

742742
1. Saving data
743-
1. Do some simple command to add / edit / delete student
744-
2. Close the app
745-
3. Reopen the app to see if your changes are saved correctly<br>
743+
1. Do some simple command to add / edit / delete student.
744+
2. Close the app.
745+
3. Reopen the app to see if your changes are saved correctly.<br>
746746
Expected: Data is saved correctly, the list should after reopen should be same as before close.
747747

748748
### Finding a person
749749

750750
1. Test case: `find John`<br>
751-
Expected: list out all students whose names and tags contain john
751+
Expected: list out all students whose names and tags contain john.
752752

753753
### Filtering a list
754754

@@ -758,11 +758,11 @@ Expected: list out all the male students.
758758
### Undoing and Redoing a action
759759

760760
1. Test case: Undo and redo a command
761-
1. Perform a simple command that is supported by undo and redo e.g. add, edit or delete
761+
1. Perform a simple command that is supported by undo and redo e.g. add, edit or delete
762762
2. Enter the command `undo`<br>
763-
Expected: the action performed in step 1 will be undo
763+
Expected: the action performed in step 1 will be undo.
764764
3. Enter the command `redo`<br>
765-
Expected: the action undone in step 2 will be redo
765+
Expected: the action undone in step 2 will be redo.
766766

767767
### Archiving Data
768768
Prerequisite: Ensure you can write in the `<HomeFolder>`
@@ -771,7 +771,7 @@ Test case: `archive pa/mybook.json`<br>
771771
Expected: The current list is cleared. Its data is stored in a json file with path `<HomeFolder>/archived/mybook.json`
772772

773773
### Loading Data
774-
Prerequisite: Ensure you have a local `json` file containing a StoreClass data to read in the folder `<HomeFolder>/archived`. This can be done by try to archive one using the previous test
774+
Prerequisite: Ensure you have a local `json` file containing a StoreClass data to read in the folder `<HomeFolder>/archived`. This can be done by try to archive one using the previous test.
775775

776776
Test case: `load pa/mybook.json`<br>
777777
Expected: The current list will be overwritten and the content of the file will be loaded into the list.

0 commit comments

Comments
 (0)