[CS2113-T13-2] LOTS#34
Conversation
brendanlsz
left a comment
brendanlsz
left a comment
There was a problem hiding this comment.
Overall, I think your DeveloperGuide is very readable and informative. Just some small formatting issues to take care of. 👍
astralum
left a comment
astralum
left a comment
There was a problem hiding this comment.
Good job overall! There are multiple minor grammatical errors, but they do not affect the overall readability of the DG.
| @@ -1,38 +1,375 @@ | |||
| # Developer Guide | |||
There was a problem hiding this comment.
Just wondering, why does your team have a DG for each member in your PR? It makes it confusing to see which DG is the one that's published.
|
|
||
| ## Design | ||
|
|
||
| ### Logical Component |
There was a problem hiding this comment.
This component is named "Logic" and not "Logical" under "Main components of architecture". Maybe it would be better to maintain consistency of naming.
|
|
||
| ### Logical Component | ||
|
|
||
| The logical component of the program consists multiple classes. Namely: `Parser`,`Command` & |
There was a problem hiding this comment.
very small typo: missing whitespace between "Parser," and "Command"
| are related to one another. | ||
| <br> | ||
|
|
||
| :information_source: **Note:** Specific command names are represented using a placeholder `'Abc'`, i.e. AddCommand, FindCommand. |
| Below is a step by step example on how the `Parser` interacts when a user keys in an input. | ||
|
|
||
| Step 1)<br> | ||
| Lets assume the user input is `delete 1/2`. `Duke` will then call the method |
There was a problem hiding this comment.
minor typo in "Lets", which should be "Let's"
| The image below shows the codes for the switch statement. | ||
|
|
||
|  | ||
|
|
There was a problem hiding this comment.
If the opt block results in an UnknownCommand being created, and so does the default case in the switch block, is it necessary to have the opt block?
| Step 1)<br> | ||
| Lets assume the user input is `delete 1/2`. `Duke` will then call the method | ||
| `Parser.getCommand("delete 1/2")`. The method would split the user's input into an array of | ||
| strings along the spaces and store them in the array `listOfInputs`. After which, |
There was a problem hiding this comment.
"split by whitespaces/spaces" might be a better phrase than "along the spaces"
|
|
||
| Step 3)<br> | ||
| Next, `Duke` will then use the returned command to call `Command.execute()` which will interact | ||
| with the `Manager Components` of the program who will then remove the 2nd order from the first |
There was a problem hiding this comment.
Did you mean to write "Manager component" instead of "Manager Components"?
Also, you could split this sentence to avoid having two "which"s in one sentence.
| break; | ||
| ``` | ||
| The upside of doing would be that there is less code overall. | ||
| However, doing so would cause our code to have a higher amount of coupling and would also |
|
|
||
| ## Architecture | ||
|
|
||
| <br> |
There was a problem hiding this comment.
Would be good if you are able to have consistent naming throughout the diagrams (eg Logic or Logical) and also use a standardised software to draw the images.
|
|
||
| This is a sequence diagram of the `Parser` class. | ||
|
|
||
|  |
There was a problem hiding this comment.
The sequence diagram for a switch case should be quite clear and shouldn't be a need to include it here. Perhaps also can include the colours that are indicated in architecture make these diagrams even clearer
| <br> | ||
|
|
||
| The Sequence Diagram below represents the interactions between components when user inputs command `delete 1/2` | ||
| <br> |
There was a problem hiding this comment.
the sequence diagrams here are a little too blurry :( the self invocation methods cannot be clearly seen too. Perhaps might want to reconsider using better diagrams and maybe not necessary to put both add and delete (since the sequence diagram for both are quite similar)
|
|
||
| Hence, the sequence of which how Menu Command class and Order Command class are very similar. To prevent repeating of Sequence diagrams, a shared diagram will be listed below for the Menu Command Class and the Order Command class. | ||
|
|
||
| <br> |
There was a problem hiding this comment.
this diagram is big and clear :) i think that one issue may be that the Ui.printOrdersList() should be pointing to the top of the activation bar instead of the middle of the activation bar.
| if there is no match) | ||
|
|
||
| The following sequence diagram depicts how the `Logical` components interact with one another upon receiving the user's input of `"delete 1/2"`. | ||
| <br> |
There was a problem hiding this comment.
This diagram looks very neat and clear, perhaps can use this as an example for your other diagrams (colour codes, size, etc)
update EditCommand, Menu
DG update drew
Edited some diagrams of the logical component
Integrated Setup for dev readme into Dev guide. Edited UML diagram to add background color.
Edited UG for PE-D Bugs
PE-D bug fix drew
Add WaiKit PPP
Format changes to PPP
Made some minor changes to DG and UG.
Add Header comment for AddCommandTest
Refactor naming for PPP
…Edit Waikit's PPP format.
Add Javadocs for test case. Removed img.png file which was not used. …
Added JavaDocs for deleteCommandTest
Edit WKPPP
Change spacing for WKPPP
Added Value Proposition & Target User.
10 participants
Large Order Tracking System (LOTS) is a Command Line (CLI) program that enables users to keep track of multiple food orders from a pre-set list of food items from different stores. The program helps users to collate the orders and displays a summary of all the orders along with other information such as each person’s order and special requirements (if any), cost of an individual’s order, total cost of all the orders and more. As LOTS is a CLI program, this would greatly benefit any user that excels in typing.