[CS2103T-T10-2] Cardi B #26
Conversation
docs/DeveloperGuide.adoc
Outdated
| 4. CardiBuddy compares the user's input with the flashcard's stored answer, and shows the user the outcome (CORRECT) as well as the flashcard's stored answer. | ||
| 5. The user chooses to go to the next flashcard | ||
| 6. CardiBuddy removes the flashcard from the <<test-queue,test queue>>. | ||
| 7. CardiBuddy shows user the question on the next flashcard in the queue. |
There was a problem hiding this comment.
Perhaps step 7 can be replaced w "repeat steps 3-6" until deck finishes.
|
Diagrams still have addressbook references like AddressBookParser and Person, even though the app does not seem to contain any contacts lists. |
docs/DeveloperGuide.adoc
Outdated
|
|
||
| image::SearchFilterDiagram.png[] | ||
|
|
||
| Figure X. Component interactions for a Search command |
docs/DeveloperGuide.adoc
Outdated
|
|
||
| The following sequence diagram shows how the `Search` command works: | ||
|
|
||
| image::SearchFilterDiagram.png[] |
There was a problem hiding this comment.
sc:SearchCommand was created but there's no contructor?
Suggestion: Why is getFilteredDeckList.size() called when filtered list has already been returned to sc?
Suggestion: sdkp is passed into sc, but sc does not call any of its methods?
| @@ -79,7 +79,7 @@ image::UiClassDiagram.png[] | |||
|
|
|||
There was a problem hiding this comment.
For Figure 3, the arrow seems to be missing for "delete 1".
|
|
||
| The following is a proposed diagram of how the `test` feature should work: | ||
|
|
||
| image::TestSequenceDiagram.png[] |
There was a problem hiding this comment.
Under "d:TestCommand", an object d seems to be created but object 't' is returned instead.
Also, the figure is not labelled.
docs/DeveloperGuide.adoc
Outdated
| === Test feature | ||
| Users can start a <<test-session>> with a chosen `Deck` by: | ||
|
|
||
| * The `index` of the deck will be provided byt he user and parsed by Cardi Buddy. A `TestSession` object containing the indicated `Deck` is created. |
|
|
||
| image::UndoRedoState0.png[] | ||
|
|
||
| Step 2. The user executes `delete 5` command to delete the 5th person in the address book. The `delete` command calls `Model#commitAddressBook()`, causing the modified state of the address book after the `delete 5` command executes to be saved in the `addressBookStateList`, and the `currentStatePointer` is shifted to the newly inserted address book state. | ||
| Step 2. The user executes `delete 5` command to delete the 5th deck in the address book. The `delete` command calls `Model#commitCardiBuddy()`, causing the modified state of CardiBuddy, after the `delete 5` command executes, to be saved in the `cardiBuddyStateList`, and the `currentStatePointer` is shifted to the newly inserted CardiBuddy state. | ||
|
|
||
| image::UndoRedoState1.png[] |
There was a problem hiding this comment.
These diagrams still contain the AddressBook class. I think you guys have forgotten to change the diagram namings.
docs/DeveloperGuide.adoc
Outdated
| The following is a proposed diagram of how the `test` feature should work: | ||
|
|
||
| image::TestSequenceDiagram.png[] |
There was a problem hiding this comment.
It would be nice to have a explanation paragraph explaining this sequence diagram, similar to the "Search and Filter feature" section. This seems to be lacking a little in terms of how it is implemented.
|
|
||
| The following is a proposed diagram of how the `test` feature should work: | ||
|
|
||
| image::TestSequenceDiagram.png[] | ||
|
|
There was a problem hiding this comment.
What about the design considerations? Why is the TestSession object responsible for updating the UniqueFlashcardList?
docs/DeveloperGuide.adoc
Outdated
|
|
||
| The following sequence diagram shows how the `Search` command works: | ||
|
|
||
| image::SearchFilterDiagram.png[] |
There was a problem hiding this comment.
SearchDeckKeywordsPredicate is constructed but the method calling it is Arrays.asList(nameKeywords) instead of SearchDeckKeywordsPredicate's constructor.
[Build Passed] Update User Guide and Developer Guide
Final Edits
[Not complete] Coveralls
@phaebaez
@airshhlay
@sigmund-c