Update import and remind use cases for DG #61
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ChooJiaXin
reviewed
Sep 30, 2020
docs/DeveloperGuide.md
Outdated
Comment on lines
316
to
320
| 1. User retrieves NUSMods timetable URL from the NUSMods website. | ||
| 2. User requests to import NUSMods timetable using their NUSMods timetable URL. | ||
| 3. Academic Schedule Manager retrieves lesson data from NUSMods API. | ||
| 4. Academic Schedule Manager adds all the lessons according to the data retrieved. | ||
| 5. Academic Schedule Manager shows a success message with details of the lessons added. |
There was a problem hiding this comment.
Looks good :) A minor nitpick is that you may want to consider removing point number 3 ("ASM retrieves lesson data from NUSMods API") as according to the textbook, use cases only describe the externally visible behavior, not internal details, of a system.
There was a problem hiding this comment.
Have edited accordingly. Thanks.
docs/DeveloperGuide.md
Outdated
Comment on lines
332
to
336
| * 2b. User already has a timetable imported before. | ||
|
|
||
| * 2b1. Academic Schedule Manager deletes all lessons from previously imported timetable. | ||
|
|
||
| Use case resumes at step 3. |
There was a problem hiding this comment.
Similar to the above comment, maybe it would be better to change the phrasing to describe how the ASM displays the lessons from the newly imported timetable
There was a problem hiding this comment.
Edited accordingly. Thank you.
|
I think it is good to merge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.