[CS2113T-T09-3] SITUS#25
Conversation
|
|
||
| The sequence diagram for when the user inputs `alerts all` is shown below. | ||
|
|
||
|  |
There was a problem hiding this comment.
Should the activation bar end when 'both lists of ingredients' is returned
There was a problem hiding this comment.
Should the activation bar of the method (ParseAlertCommand()) end before the entire class returns?
|
|
||
| The sequence diagram for the `AlertExpiringSoonCommand.run()` is shown below. The user can also call this via `alerts expiry` | ||
|
|
||
|  |
There was a problem hiding this comment.
Same as above, should the activation bar end before the return statement?
| For `AlertLowStockCommand`, it is less complicated, and the sequence diagram shown below. The user can also call this via `alerts stock` | ||
|
|
||
|
|
||
|  |
There was a problem hiding this comment.
Same as above, should the activation bar end before the return statement?
There was a problem hiding this comment.
Should the activation bar not touch the frame of the loop?
| The _sequence diagram_ below shows how the components interact with each other given a scenario where the user | ||
| enters the input `add n/carrot a/1 e/2021-11-12` | ||
|
|
||
|  |
There was a problem hiding this comment.
Should the activation bar be a full bar instead?
Roycius
left a comment
Roycius
left a comment
There was a problem hiding this comment.
DG is well done overall other than some potential improvements pointed out. Well done!
|
|
||
| The sequence diagram for when the user inputs `alerts all` is shown below. | ||
|
|
||
|  |
There was a problem hiding this comment.
Potential missing deletion of object:
AlertExpiringSoonCommandandAlertLowStockCommandwhenAlertCommandreturns,AlertCommandwhenParserreturns.
|
|
||
| The class diagram below shows the relationships between `Parser`, `Command` and `XYZCommand`. | ||
|
|
||
|  |
There was a problem hiding this comment.
Suggestion: Add {abstract} to Command in the class diagram to make it clear that it is an abstract class.
|
|
||
| ### 3.1. System Architecture | ||
|
|
||
|  |
There was a problem hiding this comment.
Consider changing the colour choices for Parser and/or Command as the current colour choices may make it hard for readers to read the words inside the box.
| Then calling `delete n/ carrot e/ 25/12/2021` will remove the second entry in the `carrot` category. | ||
| The sequence diagram below illustrates the above command example | ||
|
|
||
|  |
There was a problem hiding this comment.
The DeleteCommand instance in the diagram seems to not be referenced to anymore after Parser returns. Maybe add a "cross" here?
|
|
||
| The sequence diagram for when the user inputs `alerts all` is shown below. | ||
|
|
||
|  |
There was a problem hiding this comment.
The activation bar should end when the method returns
|
|
||
| The sequence diagram for the `AlertExpiringSoonCommand.run()` is shown below. The user can also call this via `alerts expiry` | ||
|
|
||
|  |
There was a problem hiding this comment.
There should not be an activation bar after expiryDate is returned from Ingredient and before getIngredientInfo() is invoked.
Also, The activation bar for AlertExpiringSoonCommand should not exist after it returns.
| For `AlertLowStockCommand`, it is less complicated, and the sequence diagram shown below. The user can also call this via `alerts stock` | ||
|
|
||
|
|
||
|  |
There was a problem hiding this comment.
Same as the previous diagram, the activation bar should not exist in ingredientGroup after totalAmount is returned and before toString() is called.
The activation bar for AlertExpiringSoonCommand is also too long.
|
|
||
| The sequence diagram for when the user inputs `alerts all` is shown below. | ||
|
|
||
|  |
There was a problem hiding this comment.
Also, should there be a return from parseAlertCommand() method before the method called from "alerts all" return?
|
|
||
| Below is a partial class diagram of the `IngredientList` component | ||
|
|
||
|  |
There was a problem hiding this comment.
I think you missed some arrowheads in the diagram
# Conflicts: # docs/UserGuide.md
Added exception for update and delete command
Fixed Ingredient Formatting
Changed formatting for date DATE
Updated link in UG to latest release
Updated help command
Fixed a bug for update where decimal amounts cause an exception
| The _sequence diagram_ below shows how the components interact with each other given a scenario where the user | ||
| enters the input `add n/carrot a/1 e/2021-11-12` | ||
|
|
||
|  |
There was a problem hiding this comment.
Command's instantiated object is no longer used. An cross should be drawn at the end.
|
|
||
| The sequence diagram for when the user inputs `alerts all` is shown below. | ||
|
|
||
|  |
There was a problem hiding this comment.
We need a cross for the instantiated AlertCommand once the parser returns as the instantiated object is no longer used.
|
|
||
| The sequence diagram for when the user inputs `alerts all` is shown below. | ||
|
|
||
|  |
There was a problem hiding this comment.
The activation bar should have some difference in the length to show the execution flow
|
|
||
| The sequence diagram for the `AlertExpiringSoonCommand.run()` is shown below. The user can also call this via `alerts expiry` | ||
|
|
||
|  |
There was a problem hiding this comment.
The activation bar should not get cross the OPT of the flow diagram because it is not guaranteed to execute while only expireDate is guaranteed to be returned from Ingredient
| The _sequence diagram_ below shows how the components interact with each other given a scenario where the user | ||
| enters the input `add n/carrot a/1 e/2021-11-12` | ||
|
|
||
|  |
There was a problem hiding this comment.
For this part, not very sure what "i" means here. Does it refer to the carrot that will be added to the list?
|
|
||
| The **UI** component can be found in the `UI` package. The UI reads commands from the user, sends the command to `Main` to be executed and prints an output message upon completion of the command or if an error occurred. | ||
|
|
||
| ### 3.3. Parser component |
There was a problem hiding this comment.
Instead of talking about how Parser calls the parseXYZCommand() and executes... in 3.4. Command component, will it be better to move the parseXYZCommand() part to 3.3. Parser component? Coz it is a method of the parser, and should be considered as part of the parser component I guess.
|
|
||
| ### 1.1. Purpose | ||
| This document specifies the architectural and software design decisions in the implementation of the Smart Inventory | ||
| Tracking and Updating System (SITUS). |
There was a problem hiding this comment.
Since there is "Instructions for manual testing" section in the DG, maybe can add additional purposes ( like showing the developers how to test/improve the software)?
| `IngredientList` object will only use `loadIngredientsFromMemory()` and `writeIngredientsToMemory()` methods | ||
| of the storage class only when there is a change in the ingredient list of the program. | ||
|
|
||
| ## 4. Implementation |
There was a problem hiding this comment.
For the implementation section, since this DG has one of the purposes as "specifying software design decisions", I guess it is good to also mention some of the alternatives designs your team had thought of, as well as their pros and cons, to explain why your team decided to use current design.
Fixed Bugs where thresholds can be less than or equal to 0, causing w…
…ount and expiry dates in the past for Add
Trying to fix formatting issues for DG
Still trying to fix DG formatting
Third try's the charm for fixing DG formatting
Attempt 4 at fixing formatting
This reverts commit b060c1b.
Revert "Attempt 4 at fixing formatting"
Attempt 5 at fixing DG formatting
Attempt 6 at fixing formatting issue DG
Attempt 7 at fixing DG formatting
Added some page breaks for DG PDF conversion
edit DG and AddCommandTest
Added page break
Updated J-Unit testing
Final coding style fix...
10 participants
Smart Inventory Tracking and Updating System (SITUS) will help restaurant inventory managers to keep track of and update their stock.