[CS2113-T15-4] StockMaster #45
Conversation
…layBook Branch display book
There was a problem hiding this comment.
I think you can add more visuals to aid in explaining your design and implementation
| ### Storage | ||
| Storage class contains methods to write description of items to the file `./StockMasterData.txt`, | ||
| and retrieve information from the file when program restarts. | ||
| ### UI |
There was a problem hiding this comment.
I think your UI and Exception class is missing a description
| ### Storage | ||
| Storage class contains methods to write description of items to the file `./StockMasterData.txt`, | ||
| and retrieve information from the file when program restarts. | ||
| ### UI | ||
|
|
There was a problem hiding this comment.
I think you can add some description regarding your implementation for the functionalities
docs/DeveloperGuide.md
Outdated
| @@ -7,31 +7,67 @@ | |||
| ## Design & implementation | |||
|
|
|||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} | |||
| ### Exception | |||
| ### Itemlist | |||
| Itemlist class is an object which contains items to be added to the stock inventory list. Able to add items, remove functions, edit items inside | |||
There was a problem hiding this comment.
Seems like you meant to say remove items instead of remove functions.
docs/DeveloperGuide.md
Outdated
| * has a need to manage a significant number of inventory products | ||
| * able to track revenue/loss of the business | ||
| * prefer desktop apps over other types | ||
| * can type fast | ||
| * prefers typing to mouse interactions | ||
| * is reasonably comfortable using CLI apps |
There was a problem hiding this comment.
Target users are clearly defined. Good job!
There was a problem hiding this comment.
Do consider adding in more visuals (sequence diagrams, class diagrams, etc.) for explanatory purposes.
| * list: list all items in the inventory | ||
| * help: list all commands | ||
| * exit: exit StockMaster | ||
|
|
There was a problem hiding this comment.
Hopefully, you can explain what the contents of each methods are and how the methods communicate with each related methods. This DG is to teach an interested developer how to contribute to the codebase.
docs/Diagrams/AddPromotion.png
Outdated
There was a problem hiding this comment.
The sequence diagram is clear and easy to understand, good job!
There was a problem hiding this comment.
You should add the return arrows to your sequence diagram
docs/Diagrams/DeletePromo.png
Outdated
There was a problem hiding this comment.
Maybe you could add both the activation bar and return arrows
docs/Diagrams/ListPromotion.png
Outdated
There was a problem hiding this comment.
You could try adding the activation bar and return arrows as well
docs/DeveloperGuide.md
Outdated
| used in the product. | ||
|
|
||
| {Describe the design of the product. Use UML diagrams and short code snippets where applicable.} | ||
| ### Exception |
There was a problem hiding this comment.
I think you could elaborate more on how your exception works
docs/Diagrams/DeletePromo.png
Outdated
There was a problem hiding this comment.
- missing closing bracket in print
- add return arrow when necessary :)
src/main/java/common/Messages.java
Outdated
There was a problem hiding this comment.
good to see self invocation here !
docs/DeveloperGuide.md
Outdated
| and retrieve information from the file when program restarts. | ||
| ### UI | ||
|
|
||
| <<<<<<< HEAD |
There was a problem hiding this comment.
please delete the unnecessary lines :) !
There was a problem hiding this comment.
I am a bit confuse what does "BESTSELLER", "TOTAL_PROFIT", "TOTAL_REVENUE" means?
There was a problem hiding this comment.
Good job in use red to diftinquish the parts.
docs/Diagrams/AddPromotion.png
Outdated
Update PPP
Update Cashier exception handling
Update DG
Update PPP Formatting
Update Storage Sequence Diagram
FINAL BUGFIX
Update PPP
Fix DG wording
Change UG and DG wording
Update UG
Update JAR link
Update UserGuide.md
StockMaster helps small business owners manage inventory of their business. It is optimized for CLI users so that frequent tasks can be done faster by typing in commands.