[CS2113-F15-4] BookBuddy#54
Conversation
…dler Successfully set up file handler. Florizz.xml file will appear if for…
| from the main code. It is instead replaced by a simple interface for the user to work with, adhering to the abstraction concept of | ||
| object-oriented programming. | ||
|
|
||
| ## Product scope |
There was a problem hiding this comment.
Could you give more elaborations on user stories?
JingHaoooo
left a comment
JingHaoooo
left a comment
There was a problem hiding this comment.
Overall good job. Diagrams were mostly clear and easy to understand.
| - An embedded approach, where genre setting logic is part of a larger class managing all book attributes, was | ||
| considered. However, this was rejected due to potential scalability issues and difficulty in maintaining code. | ||
|
|
||
|  |
There was a problem hiding this comment.
Is this correct? Should it be returning any value(eg genres)?
| By importing predefined string constants from `CommandList` class representing the valid commands, the `ParserMain` class | ||
| parses the input from a user using the `parseCommand` method. The class diagram below shows how `ParserMain` interacts with other | ||
| classes. | ||
|  |
There was a problem hiding this comment.
Perhaps you could remove the icons in the class diagrams, as well as the attributes icons.
| | v1.0 | user | add books to a list | | | ||
| | v1.0 | user | remove books from a list | | |
There was a problem hiding this comment.
Perhaps you could add the part for "so that I can" to make it complete.
LowTL
left a comment
LowTL
left a comment
There was a problem hiding this comment.
Well done on the DG! There are a few small placeholder texts to delete, but generally well done!
|
|
||
| Reference to AB-3 diagrams code | ||
| * [Source URL](https://github.com/se-edu/addressbook-level3/tree/master/docs/diagrams) | ||
| * Used as reference to understand PlantUML syntax |
There was a problem hiding this comment.
I like how you give credit to the sources you referenced!
| enhancing maintainability and scalability. | ||
|
|
||
| #### Alternatives Considered: | ||
|
|
|
|
||
| By abstracting out the parsing functionality of BookBuddy into a separate `ParserMain` class, the complexity of parsing | ||
| user input is removed from the main code. It is instead replaced by a simple interface for the user to work with, adhering to the abstraction | ||
| concept of object-oriented programming. |
|
|
||
| ### Value proposition | ||
|
|
||
| {Describe the value proposition: what problem does it solve?} |
There was a problem hiding this comment.
Perhaps you could add a value proposition so that developers can understand at a glance what your program can offer.
|
|
||
| ## Design & implementation | ||
|
|
||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} |
There was a problem hiding this comment.
Perhaps you could remove the placeholder text so that it's clearer where the Design and Implementation section begins
| @@ -1,29 +1,194 @@ | |||
| # Developer Guide | |||
|
|
|||
| ## Table of Contents | |||
There was a problem hiding this comment.
Good use of a Table of Contents to allow easy navigation of the DG!
find based on read and unread status implemented
updated UG and list of commands in help
Add single step operation of set-genre method for pro users
Update user guide
Update developer guide
…find-title and find-genre
Update UG
fix bug such that capitalization of letters do not matter when using …
Bug fix for set-genre feature
Fix bugs in genre and label commands
update UG
Update PPP
Bug fix - replace split criteria as \\s+ instead of space
Update UG
Refactor code for set-genre feature for code readability
Update UG
Bug Fixes and refactoring
Update DG
Update About Us
# Conflicts: # docs/AboutUs.md
Update DG
Update user guide
7 participants
BookBuddy helps users track and manage the list of the books they are reading. It is optimized for CLI users so that the tracking and management objectives can be achieved most efficiently.