Skip to content

Commit

Permalink
Minor clean DG/UG
Browse files Browse the repository at this point in the history
  • Loading branch information
yijiano committed Nov 12, 2024
1 parent c3c9954 commit dd05811
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
9 changes: 6 additions & 3 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,8 @@
- [Storage](#storage)
- [Item and ItemMap](#item-and-itemmap)
- [Orders and Transactions](#orders-and-transactions)
- [StringMatcher](#stringmatcher)
- [Visualizer](#visualizer)
- [Parser](#parser)
- [DateTime](#datetime)
- [TimeStampIO](#timestampio)
- [Exceptions](#exceptions)
- [Logging](#logging)
- [Product scope](#product-scope)
Expand Down Expand Up @@ -418,3 +415,9 @@ All tests passed!
// Tests failed: 1
```

## Future Enhancements
- Implement the ability to take in special characters in item names.
- Implement a feature to track the price of items.
- Implement a feature to track the cost of items.
- Implement a feature to track the profit of items.
3 changes: 1 addition & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
**Version 2.0**

1. [Introduction](#introduction)
2. [Important Note](#important-note)
- [Case Sensitivity](#case-sensitivity)
2. [Important Usage Notes](#important-usage-notes)
- [No special characters](#no-special-characters)
- [Expiry Date](#expiry-date)
3. [Features](#features)
Expand Down
Binary file modified docs/diagrams/High-Level-Overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/diagrams/High-Level-Overview.puml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ package "pill" {
command -> PillLogger
Parser --> exceptions

command --> TransactionManager
command --> Visualizer

ItemMap -> Storage

PillException -left> ExceptionMessages
Expand Down

0 comments on commit dd05811

Please sign in to comment.