Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update theme sequence diagram and add fullstops to use case #348

Merged
merged 1 commit into from
Nov 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 41 additions & 40 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1157,10 +1157,10 @@ otherwise.

**MSS**

1. User requests to list tutors
2. TutorConnect shows a list of tutors
3. User requests to edit a specific tutor information in the list
4. TutorConnect modifies the tutor information
1. User requests to list tutors.
2. TutorConnect shows a list of tutors.
3. User requests to edit a specific tutor information in the list.
4. TutorConnect modifies the tutor information.

Use case ends.

Expand Down Expand Up @@ -1188,10 +1188,10 @@ otherwise.

**MSS**

1. User requests to list tutors
2. TutorConnect shows a list of tutors
3. User requests to delete a specific tutor in the list
4. TutorConnect deletes the tutor
1. User requests to list tutors.
2. TutorConnect shows a list of tutors.
3. User requests to delete a specific tutor in the list.
4. TutorConnect deletes the tutor.

Use case ends.

Expand All @@ -1213,10 +1213,10 @@ otherwise.

**MSS**

1. User requests to list tutors
2. TutorConnect shows a list of tutors
3. User requests to add a schedule for a specific tutor in the list
4. TutorConnect adds the schedule and displays a list of schedule
1. User requests to list tutors.
2. TutorConnect shows a list of tutors.
3. User requests to add a schedule for a specific tutor in the list.
4. TutorConnect adds the schedule and displays a list of schedule.

Use case ends.
<div style="page-break-after: always;"></div>
Expand Down Expand Up @@ -1244,10 +1244,10 @@ otherwise.

**MSS**

1. User requests to list schedules
2. TutorConnect shows a list of schedules
3. User requests to edit a specific schedule information in the list
4. TutorConnect modifies the schedule information
1. User requests to list schedules.
2. TutorConnect shows a list of schedules.
3. User requests to edit a specific schedule information in the list.
4. TutorConnect modifies the schedule information.

Use case ends.

Expand Down Expand Up @@ -1275,8 +1275,8 @@ otherwise.

**MSS**

1. User requests to list schedules by tutor and/or schedule status
2. TutorConnect shows a list of schedules
1. User requests to list schedules by tutor and/or schedule status.
2. TutorConnect shows a list of schedules.

Use case ends.

Expand All @@ -1300,8 +1300,8 @@ otherwise.

**MSS**

1. User requests to find schedules by typing in keywords
2. TutorConnect shows a list of schedules filtered by keyword entered
1. User requests to find schedules by typing in keywords.
2. TutorConnect shows a list of schedules filtered by keyword entered.

Use case ends.

Expand All @@ -1310,10 +1310,10 @@ otherwise.

**MSS**

1. User requests to list schedules
2. TutorConnect shows a list of schedules
3. User requests to delete a specific schedule in the list
4. TutorConnect deletes the schedule
1. User requests to list schedules.
2. TutorConnect shows a list of schedules.
3. User requests to delete a specific schedule in the list.
4. TutorConnect deletes the schedule.

Use case ends.

Expand All @@ -1334,10 +1334,10 @@ otherwise.

**MSS**

1. User requests to list schedules
2. TutorConnect shows a list of schedules
3. User requests to mark a specific schedule in the list as completed
4. TutorConnect marks the schedule as completed
1. User requests to list schedules.
2. TutorConnect shows a list of schedules.
3. User requests to mark a specific schedule in the list as completed.
4. TutorConnect marks the schedule as completed.

Use case ends.

Expand All @@ -1358,10 +1358,10 @@ otherwise.

**MSS**

1. User requests to list schedules
2. TutorConnect shows a list of schedules
3. User requests to unmark a specific schedule in the list
4. TutorConnect unmarks the schedule
1. User requests to list schedules.
2. TutorConnect shows a list of schedules.
3. User requests to unmark a specific schedule in the list.
4. TutorConnect unmarks the schedule.

Use case ends.

Expand All @@ -1371,6 +1371,7 @@ otherwise.

Use case ends.
<div style="page-break-after: always;"></div>

* 3a. The given index is invalid.

* 3a1. TutorConnect shows an error message.
Expand All @@ -1383,10 +1384,10 @@ otherwise.

**MSS**

1. User requests to list tutors
2. TutorConnect shows a list of tutors
3. User requests to view schedules for a specific tutor in the list
4. TutorConnect displays a list of schedules for the tutor
1. User requests to list tutors.
2. TutorConnect shows a list of tutors.
3. User requests to view schedules for a specific tutor in the list.
4. TutorConnect displays a list of schedules for the tutor.

Use case ends.

Expand Down Expand Up @@ -1418,9 +1419,9 @@ otherwise.

### Glossary

* **Mainstream OS**: Windows, Linux, Unix, OS-X
* **Use case**: A description of a set of sequences of actions, including variants, that a system performs to yield an observable result of value to an actor
* **GUI**: Graphical user interface
* **Mainstream OS**: Windows, Linux, Unix, OS-X.
* **Use case**: A description of a set of sequences of actions, including variants, that a system performs to yield an observable result of value to an actor.
* **GUI**: Graphical user interface.

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

Expand All @@ -1437,7 +1438,7 @@ testers are expected to do more *exploratory* testing.

1. Initial launch

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

2. Double-click the jar file Expected: Shows the GUI with a set of sample tutors and schedules. The window size may
not be optimum.
Expand Down
2 changes: 1 addition & 1 deletion docs/diagrams/ChangeThemeSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ deactivate ThemeCommand
LogicManager --> Ui : result
deactivate LogicManager

Ui --> Ui : handle\nChange\nTheme()
Ui -> Ui : handle\nChange\nTheme()

[<--Ui
deactivate Ui
Expand Down
Binary file modified docs/images/ChangeThemeSequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.