Skip to content

Commit 9b24208

Browse files
authored
Merge pull request #250 from ShengBin-101/shengbin-PPP
Update shengbin PPP
2 parents 1f6bcaf + 0d14377 commit 9b24208

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

docs/team/shengbin-101.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,30 @@ BookKeeper is a Command Line Interface (CLI) library manager application for eff
99
#### **Code Contributed**
1010
- [RepoSense Link](https://nus-cs2113-ay2425s2.github.io/tp-dashboard/?search=shengbin-101&breakdown=true)
1111

12-
#### **Enhancements Implemented**
13-
1. **Loan Addition**:
12+
#### **Features Implemented**
13+
1. **`add-loan` command**:
1414
- **What it does**: Allows users to add loans for books, specifying borrower details such as name, return date, phone number, and email.
1515
- **Justification**: This feature is essential for tracking which books are currently on loan and who borrowed them. It enhances the core functionality of the library management system.
1616
- **Highlights**: Includes validation to prevent adding loans for books that are already on loan.
1717

18-
2. **Formatter**:
18+
2. **`Formatter` class**:
1919
- **What it does**: Provides a centralized utility for formatting output messages, such as error messages, success messages, and lists.
2020
- **Justification**: Improves the user experience by ensuring consistent and readable output across all commands.
2121
- **Highlights**: Supports formatting for book lists, loan lists, and error messages.
2222

2323
3. **Storage Validation**:
2424
- **What it does**: Validates the consistency of data between the `BookList` and `LoanList` during loading. Removes invalid loans and fixes discrepancies in book statuses (e.g., `onLoan` status).
2525
- **Justification**: Ensures data integrity when loading from files, preventing crashes and maintaining a consistent state.
26-
- **Highlights**: Handles duplicate books, invalid loans, and mismatched `onLoan` statuses.
26+
- **Highlights**: Handles invalid entries, duplicate books, invalid loans, and mismatched `onLoan` statuses.
2727

2828
4. **Dynamic Ordering of Arguments**:
29-
- **What it does**: Allows users to input command arguments in any order, as long as all required arguments are provided. For example, the command add-loan accepts arguments like `BOOK_TITLE`, `BORROWER_NAME`, `RETURN_DATE`, `PHONE_NUMBER`, and `EMAIL` in any order.
29+
- **What it does**: Allows users to input command arguments in any order, as long as all required arguments are provided. For example, the command `edit-loan` accepts arguments like `BORROWER_NAME`, `RETURN_DATE`, `PHONE_NUMBER`, and `EMAIL` in any order.
3030
- **Justification**: This feature improves the user experience by making commands more flexible and forgiving. Users do not need to memorize a strict order for arguments, reducing the likelihood of input errors.
3131
- **Highlights**:
32-
Implemented a parser that dynamically identifies and maps arguments based on prefixes (e.g., n/ for name, d/ for return date).
33-
Includes validation to ensure all required arguments are present and correctly formatted.
34-
Supports optional arguments (e.g., note/NOTE for books) without affecting the required arguments.
32+
- Implemented a parser that dynamically identifies and maps arguments based on prefixes (e.g., n/ for name, d/ for return date).
33+
- Includes validation to ensure all required arguments are present and correctly formatted.
34+
- Supports optional arguments (e.g., note/NOTE for books) without affecting the required arguments.
35+
- Includes checking of duplicate prefixes/arguments given by user.
3536

3637
#### **Contributions to the User Guide**
3738
- Added documentation for the following commands:
@@ -46,9 +47,14 @@ BookKeeper is a Command Line Interface (CLI) library manager application for eff
4647

4748
#### **Contributions to the Developer Guide**
4849
- Wrote the implementation details for:
49-
- Loan addition
50+
- Section on Adding Loans
51+
- Section on Search Title
52+
- Section on Save/Load Inventory
53+
- Section on Save/Load Loans
5054
- Added UML diagrams for:
51-
- Sequence Diagram for add-loan.
55+
- Sequence Diagram for Adding Loans.
56+
- Sequence Diagram for Save/Load Inventory.
57+
- Sequence Diagram for Save/Load Loans.
5258

5359
#### **Contributions to Team-Based Tasks**
5460
- Maintained the issue tracker and managed milestones.

0 commit comments

Comments
 (0)