[CS2113-F15-4] BookBuddy #54
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JeffinsonDarmawan
added a commit
to JeffinsonDarmawan/tp
that referenced
this pull request
Mar 22, 2024
…dler Successfully set up file handler. Florizz.xml file will appear if for…
Luo-Z-Y
reviewed
Apr 3, 2024
|
|
||
| By abstracting out the parsing functionality of BookBuddy into a separate `Parser` 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. | ||
|
|
||
| ## Product scope |
There was a problem hiding this comment.
Could you give more elaborations on user stories?
JingHaoooo
reviewed
Apr 4, 2024
| - 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.
docs/DeveloperGuide.md
Outdated
Comment on lines
179
to
180
| | 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
reviewed
Apr 4, 2024
|
|
||
| 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. |
docs/DeveloperGuide.md
Outdated
| Progress for each book can be recorded according to the number of pages read. | ||
| Users will be able to sort books according to genre. | ||
| Users can sort books according to Read or Unread. | ||
| Users will also be able to search for books via keywords in book titles | ||
|
|
||
| ### 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.
docs/DeveloperGuide.md
Outdated
| 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 | ||
|
|
||
| ## 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.