Update DG for CountryNotesManager #245
Conversation
raysonkoh
added
the
type.documentation
Codecov Report
@@ Coverage Diff @@
## master #245 +/- ##
=========================================
Coverage 87.47% 87.47%
Complexity 900 900
=========================================
Files 109 109
Lines 2299 2299
Branches 251 251
=========================================
Hits 2011 2011
Misses 218 218
Partials 70 70 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Regarding the sequence diagram, I'm guessing the intermediate portions where AddressBookParser calls CountryNoteAddCommandParser is supposed to be abstracted out for brevity? Also, there is an intermediate call to AddressBook from Model before CountryNotesManager.
docs/DeveloperGuide.md
Outdated
|
|
||
| Given below is a sequence diagram that shows how the `country note add` command works. | ||
| For brevity, the full command `country note add c/COUNTRY_CODE nt/NOTE_STRING` will be substituted by `country note add`. | ||
| Note that the `AddressBookParser` parses the user input and returns a `CountryNote` object, which will be passed as an argument to the constructor of `CountryNoteAddCommand`. |
There was a problem hiding this comment.
Slightly inaccurate as AddressBookParser returns a Command type. Maybe talk about CountryNoteAddCommandParser which extracts Country and Note into CountryNote?
There was a problem hiding this comment.
Yea thanks for catching that mistake, will mention about CountryNoteAddCommandParser and also say that it will be excluded from the sequence diagram for brevity.
Added the intermediate call to Addressbook#addCountryNote(countryNote)
Description
Include Class Diagram for CountryNote-related classes in model + Sequence Diagram for Country Note Add.
Fixes #238
Testing
No tests were added.
Remarks
NIL