Skip to content

Commit

Permalink
Merge pull request #263 from CFSY/dg
Browse files Browse the repository at this point in the history
Dg
  • Loading branch information
CFSY authored Nov 7, 2022
2 parents 8253620 + 6db2547 commit 4857d94
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 23 deletions.
18 changes: 2 additions & 16 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ title: Developer Guide
## **Acknowledgements**

* [Apache PDFBox®](https://pdfbox.apache.org/)
* {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
* * [Apache Commons](https://commons.apache.org/)

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

Expand Down Expand Up @@ -319,7 +319,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
| `*` | fast user | add custom shortcuts for commands | |


*{More to be added}*

### Use cases

Expand Down Expand Up @@ -408,7 +407,6 @@ Use case ends.
Use case ends.


*{More to be added}*

### Non-Functional Requirements

Expand All @@ -418,7 +416,6 @@ Use case ends.
4. The GUI should be intuitive and easy to understand.
5. The system should respond in at most 1 second.

*{More to be added}*

### Glossary

Expand Down Expand Up @@ -447,10 +444,9 @@ testers are expected to do more *exploratory* testing.

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 …​ }_

### Deleting an itinerary

Expand All @@ -464,13 +460,3 @@ testers are expected to do more *exploratory* testing.

1. 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 …​ }_

### 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 changes: 1 addition & 1 deletion docs/SettingUp.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ If you plan to use Intellij IDEA (highly recommended):

1. **Learn the design**

When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [AddressBook’s architecture](DeveloperGuide.md#architecture).
When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [Waddle’s architecture](DeveloperGuide.md#architecture).

1. **Do the tutorials**
These tutorials will help you get acquainted with the codebase.
Expand Down
12 changes: 6 additions & 6 deletions docs/diagrams/ModelClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Class UserPrefs
Class UniqueItineraryList
Class Itinerary
Class People
Class duration
Class Name
Class Duration
Class Description
Class Country
Class Tag

Expand All @@ -36,14 +36,14 @@ UserPrefs .up.|> ReadOnlyUserPrefs

Waddle *--> "1" UniqueItineraryList
UniqueItineraryList --> "~* all" Itinerary
Itinerary *--> Name
Itinerary *--> Description
Itinerary *--> Country
Itinerary *--> duration
Itinerary *--> Duration
Itinerary *--> People

Name -[hidden]right-> Country
Description -[hidden]right-> Country
Country -[hidden]right-> People
People -[hidden]right-> duration
People -[hidden]right-> Duration

ModelManager -->"~* filtered" Itinerary
@enduml
Binary file modified docs/images/ModelClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4857d94

Please sign in to comment.