Skip to content

Commit

Permalink
Merge pull request AY2425S1-CS2103T-T12-4#313 from Kitty-001/master
Browse files Browse the repository at this point in the history
Update User Guide and Developer Guide
  • Loading branch information
JJtan2002 authored Nov 10, 2024
2 parents 5642543 + fbb941a commit 9b2b045
Show file tree
Hide file tree
Showing 5 changed files with 146 additions and 51 deletions.
46 changes: 37 additions & 9 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -592,38 +592,66 @@ testers are expected to do more *exploratory* testing.

1. Download the jar file and copy into an empty folder

1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.
2. Run `java -jar gamerbook.jar` in the Terminal in the _home folder_ Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.

1. Saving window preferences
2. Saving window preferences

1. Resize the window to an optimum size. Move the window to a different location. Close the window.

1. Re-launch the app by double-clicking the jar file.<br>
2. Re-launch the app by double-clicking the jar file.<br>
Expected: The most recent window size and location is retained.

1. _{ more test cases …​ }_
3. _{ more test cases …​ }_

### Deleting a person

1. Deleting a person while all persons are being shown

1. Prerequisites: List all persons using the `list` command. Multiple persons in the list.

1. Test case: `delete 1`<br>
2. Test case: `delete 1`<br>
Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated.

1. Test case: `delete 0`<br>
3. Test case: `delete 0`<br>
Expected: No person is deleted. Error details shown in the status message. Status bar remains the same.

1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)<br>
4. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)<br>
Expected: Similar to previous.

1. _{ more test cases …​ }_
2. _{ more test cases …​ }_

### Saving data

1. Dealing with missing/corrupted data files

1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_

1. _{ more test cases …​ }_
2. _{ more test cases …​ }_

------------------------------------------------------------

## **Appendix: Planned Enhancement**

### Preferred Time: Make Overnight Ranges Functional

Preferred Time currently doesn't accept overnight range, e.g. "2300-0100" is currently not accepted.
So users cannot add, edit overnight ranges to contacts. Using `findtime` command with overnight ranges
also triggers "invalid command..." error.

We plan to adjust the requirement so that overnight ranges will be accepted, which offers users more convenience
as many gamers play late night to early hours in the morning. People usually don't have time during the day to game.

Current workaround with the issue:
For range input `2300-0100`, users can break down to `2300-2359` and `0000-0100`. This shall work as valid inputs and `add`,
`edit`, and `findtime` should be able to work properly with this.

### FindTime Command: Adjustment on Boundary Overlapping

FindTime Command `findtime` is currently border sensitive.
e.g.:
`findtime 2200-2300` will return you all the person cards whose preferred times overlap with `2200-2300`,
with range `2100-2200` and `2300-2330` counted as overlapping. Which should not be the case, as there is
only overlap at the boundary.

We plan to adjust the overlapping mechanism so that ranges meet only at the boundary will not be counted as overlapping.

6 changes: 3 additions & 3 deletions docs/SettingUp.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@ If you plan to use Intellij IDEA (highly recommended):
1. **Do the tutorials**
These tutorials will help you get acquainted with the codebase.

* [Tracing code](tutorials/TracingCode.md)
* [Adding a new command](tutorials/AddRemark.md)
* [Removing fields](tutorials/RemovingFields.md)
* [Tracing code](https://se-education.org/guides/tutorials/ab3TracingCode.html)
* [Adding a new command](https://se-education.org/guides/tutorials/ab3AddRemark.html)
* [Removing fields](https://se-education.org/guides/tutorials/ab3RemovingFields.html)
Loading

0 comments on commit 9b2b045

Please sign in to comment.