diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index cdec39ddcc2..8dd34ee67c1 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -951,7 +951,7 @@ testers are expected to do more *exploratory* testing. 5. Run `java -jar TAPro.jar`. -Expected: TAPro launches and shows the GUI with a set of sample student contacts. The window size may not be optimal. +Expected: TAPro launches and shows the GUI with a set of sample student contacts. The window size may not be optimal. 2. **Saving window preferences** @@ -967,7 +967,7 @@ Expected: TAPro launches and shows the GUI with a set of sample student contacts 3. Re-launch the app by double-clicking the jar file.
-Expected: The most recent window size and location is retained. +Expected: The most recent window size and location is retained.
@@ -986,13 +986,16 @@ students. -2. Test case: `addstu n/John Doe p/98765432 e/johndoe@example.com nn/E0123456 m/Computer Science, #02-25 t/friends t/owesMoney` +2. Test case: +``` +addstu n/John Doe p/98765432 e/johndoe@example.com nn/E0123456 m/Computer Science, #02-25 t/friends t/owesMoney +``` -Expected: Student with NUSNet ID `E0123456` is added into TAPro. Details of the added student is +Expected: Student with NUSNet ID `E0123456` is added into TAPro. Details of the added student is shown in the result message panel. -1. **Adding a student with NUSNet ID E0123457** +2. **Adding a student with NUSNet ID E0123457** @@ -1001,9 +1004,12 @@ shown in the result message panel. -2. Test case: `addstu n/Mary Jane p/91234911 e/janemary@example.com nn/E0123457 m/Biology t/friends t/owesTutorial2` +2. Test case: +``` +addstu n/Mary Jane p/91234911 e/janemary@example.com nn/E0123457 m/Biology t/friends t/owesTutorial2 +``` -Expected: Student with NUSNet ID `E0123457` is added into TAPro. Details of the added student is +Expected: Student with NUSNet ID `E0123457` is added into TAPro. Details of the added student is shown in the result message panel. @@ -1024,10 +1030,12 @@ the above last `addstu` command to add a student with NUSNet ID E0123457 if it d -2. Test case: `edit 2 p/98765432 m/Computer Science` - +2. Test case: +``` +edit 2 p/98765432 m/Computer Science +``` -Expected: Information of student with NUSNet ID `E0123457` is updated in TAPro. Details of the added student is +Expected: Information of student with NUSNet ID `E0123457` is updated in TAPro. Details of the added student is shown in the status message. @@ -1050,18 +1058,32 @@ This command differs from most other commands that use the `NUSNET` to identify -2. Test case: `delstu nn/E0123456` +2. Test case: +``` +delstu nn/E0123456 +``` -Expected: The student with NUSNet ID `E0123456` is deleted from TAPro. Details of the deleted student +Expected: The student with NUSNet ID `E0123456` is deleted from TAPro. Details of the deleted student shown in the result message panel. 3. Other incorrect `delstu` commands to try: -* `delstu`: Missing parameter and prefix. -* `delstu nn/E6543210`: No student with this NUSNet ID. -* `delstu E0123456`: Missing prefix for the NUSNet ID parameter. +* Missing parameter and prefix: +``` +delstu +``` + +* No student with this NUSNet ID: +``` +delstu nn/E6543210 +``` + +* Missing prefix for the NUSNet ID parameter: +``` +delstu E0123456 +```
@@ -1078,18 +1100,25 @@ shown in the result message panel. -2. Test case: `find john` +2. Test case: +``` +find john +``` -Expected: Student with name 'John Doe' is displayed on the Student Contact Cards Panel. +Expected: Student with name 'John Doe' is displayed on the Student Contact Cards Panel. 3. Other incorrect `find` commands to try: -* `find`: Missing keyword. - +* Missing keyword: +``` +find +``` +
+{{ newPageBetween }} ### Marking a student's attendance @@ -1102,19 +1131,37 @@ Expected: Student with name 'John Doe' is displayed on the Student Contact Cards -2. Test case: `mark nn/E0123456 wk/1` +2. Test case: +``` +mark nn/E0123456 wk/1 +``` -Expected: Student with NUSNet ID `E0123456` is marked as present for week 1 in TAPro, depicted on that student's card in the panel. +Expected: Student with NUSNet ID `E0123456` is marked as present for week 1 in TAPro, depicted on that student's card in the panel. Details of the marked student is shown in the result message panel. 3. Examples of incorrect `mark` commands to try: -* `mark`: Missing NUSNet ID and week number parameters. -* `mark nn/E6543210 wk/1`: No student with this NUSNet ID. -* `mark wk/1`: Missing the NUSNet ID parameter. -* `mark E0123456 1`: Missing prefix for the NUSNet ID and week number parameters. +* Missing NUSNet ID and week number parameters: +``` +mark +``` + +* No student with this NUSNet ID: +``` +mark nn/E6543210 wk/1 +``` + +* Missing the NUSNet ID parameter: +``` +mark wk/1 +``` + +* Missing prefix for the NUSNet ID and week number parameters: +``` +mark E0123456 1 +```
@@ -1131,9 +1178,12 @@ student with NUSNet ID `E6543210`. -2. Test case: `unmark nn/E0123456 wk/1` +2. Test case: +``` +unmark nn/E0123456 wk/1 +``` -Expected: Student with NUSNet ID `E0123456` is not marked as for week 1 in TAPro, depicted on that student's +Expected: Student with NUSNet ID `E0123456` is not marked as for week 1 in TAPro, depicted on that student's card in the panel. Details of the marked student is shown in the status message. @@ -1141,10 +1191,25 @@ Details of the marked student is shown in the status message. 3. Examples of incorrect `unmark` commands to try: -* `unmark`: Missing NUSNet ID and week number parameters. -* `unmark nn/E6543210 wk/1`: No student with this NUSNet ID. -* `unmark wk/1`: Missing the NUSNet ID parameter. -* `unmark E0123456 1`: Missing prefix for the NUSNet ID and week number parameters. +* Missing NUSNet ID and week number parameters: +``` +unmark +``` + +* No student with this NUSNet ID: +``` +unmark nn/E6543210 wk/1 +``` + +* Missing the NUSNet ID parameter: +``` +unmark wk/1 +``` + +* Missing prefix for the NUSNet ID and week number parameters: +``` +unmark E0123456 1 +```
@@ -1161,7 +1226,10 @@ Details of the marked student is shown in the status message. -2. Test case: `setcrs CS2103` +2. Test case: +``` +setcrs CS2103 +``` @@ -1169,10 +1237,11 @@ Enter `setcrs` followed by a whitespace, followed by a course code in the format in upper or lower case, `YYYY` can be any 4-digit number and `Z` is optional. -Expected: TAPro's main window's title contains the course code `CS2103` provided. +Expected: TAPro's main window's title contains the course code `CS2103` provided.
+{{ newPageBetween }} ### Autocompleting fields @@ -1185,9 +1254,16 @@ Expected: TAPro's main window's title contains the course code `CS2103` provided -2. Test case: Enter `a` and press {{ macros.keyFormat('Tab') }} +2. Test case: +``` +a +``` +Then press {{ macros.keyFormat('Tab') }}. -Expected: The command box input text changes to `addstu`. +Expected: The command box input text changes to: +``` +addstu +``` @@ -1200,9 +1276,16 @@ Expected: The command box input text changes to `addstu`. -2. Test case: Enter `edit 1 m/` and press {{ macros.keyFormat('Tab') }} +2. Test case: +``` +edit 1 m/ +``` +Then press {{ macros.keyFormat('Tab') }}. -Expected: The command box input text changes to `edit 1 m/Computer Science` +Expected: The command box input text changes to: +``` +edit 1 m/Computer Science +```
@@ -1211,7 +1294,10 @@ Expected: The command box input text changes to `edit 1 m/Computer Science` -1. Prerequisites: Previously ran a successful command like `mark nn/E0123456 wk/6`. +1. Prerequisites: Ran the following command as the previous command: +``` +mark nn/E0123456 wk/6 +``` @@ -1220,12 +1306,15 @@ Expected: The command box input text changes to `edit 1 m/Computer Science` 2. Test case: Retrieving a previous command with {{ macros.keyFormat('Up', '') }} key -* After the entering a previous command, the command input box is empty. +* After the entering that previous command, the command input box is empty. * Pressing {{ macros.keyFormat('Up', '') }} will fill the text in the command input box to - the previous command `mark nn/E0123456`! + the previous command: +``` +mark nn/E0123456 wk/6 +``` * You can press {{ macros.keyFormat('Up', '') }} continuously to scroll - through all the previous commands you have entered. + through all the previous (successful) commands you have entered. * Pressing {{ macros.keyFormat('Down', '') }} will scroll back to the more recent commands you have entered. @@ -1233,6 +1322,7 @@ Expected: The command box input text changes to `edit 1 m/Computer Science`
+{{ newPageBetween }} ### Accessing help @@ -1245,9 +1335,12 @@ Expected: The command box input text changes to `edit 1 m/Computer Science` -2. Test case: `help` +2. Test case: +``` +help +``` -Expected: The help window automatically pops up, giving further information about TAPro's commands. +Expected: The help window automatically pops up, giving further information about TAPro's commands.
@@ -1263,9 +1356,12 @@ Expected: The help window automatically pops up, giving further information abou -2. Test case: `clear` +2. Test case: +``` +clear +``` -Expected: TAPro's Contact Book resets, clearing all existing students (if any). +Expected: TAPro's Contact Book resets, clearing all existing students (if any). {{ newPage }}