[beefsausagee] iP #457
Open
[beefsausagee] iP #457
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
Let's tweak the docs/README.md (which is used as the user guide) to fit Duke better. Specifically, 1. mention product name in the title 2. mention adding a product screenshot and a product intro 3. tweak the flow to describe feature-by-feature
kwuunnn
reviewed
Feb 6, 2024
src/main/java/Duke.java
Outdated
| } | ||
|
|
||
| /** | ||
| * Displays a greeting message |
There was a problem hiding this comment.
I think the sentence should end with a fullstop. I noticed the same issue in several other places too.
src/main/java/Duke.java
Outdated
| /** | ||
| * Displays a greeting message | ||
| * | ||
| * @param botName Name of the bot |
There was a problem hiding this comment.
Likewise, I think each parameter description should end with a fullstop. I noticed the same issue in several other places too.
xuelinglow
reviewed
Feb 9, 2024
| * @param task Task input | ||
| * @param listOfTasks List of all tasks | ||
| */ | ||
| public static void repeatFunction(Task task, ArrayList<? extends Task> listOfTasks) { |
There was a problem hiding this comment.
Perhaps it would be better to use a more descriptive function name to make it more clear what the function does
e.g notifyTaskAdded
There are some methods in UI that did not follow the naming standard Changing the name imporves code quality
This commit introduces assertions to enhance input validation and error handling in the XiaoBai application. Assertions are used throughout the codebase to ensure that critical assumptions about the input data are met, helping to catch potential bugs and improve overall code reliability. - Assertions have been added to the `getResponse` method in the `XiaoBai` class to check for empty task details in various user commands, including TODO, DEADLINE, EVENT, MARK, UNMARK, DELETE, and FIND. - When empty task details are detected, assertions throw an AssertionError, providing clear feedback to developers during testing and debugging. - Additionally, appropriate error handling has been implemented to catch AssertionError and handle it gracefully, preventing unexpected termination of the application. This enhancement enhances the robustness of the application and contributes to a more stable and reliable user experience. It lays the groundwork for more thorough input validation and error handling strategies in future iterations of the XiaoBai application.
Add assertions to improve input validation and error handling
This commit adds Javadoc comments to all public methods and classes in the project to improve code documentation and readability. Each class and method now has a comprehensive Javadoc comment explaining its purpose, parameters, return values (if applicable), and any exceptions thrown. The following changes were made: - Added Javadoc comments to all public methods and classes in the project. - Updated the comments to follow standard conventions and provide clear explanations of each component's functionality. - Ensured consistency in commenting style and format throughout the project. - Reviewed and refined existing comments to ensure accuracy and completeness. These Javadoc comments will enhance code maintainability and facilitate better understanding for developers working on the project. They serve as comprehensive documentation for the project's API, making it easier for users to utilize and extend the functionality of the application.
Add Javadoc comments to all classes in the project
Added extension C-Sort
…rk, unmark, delete, and find commands
Added Ui.png into docs
minghowC
reviewed
Feb 27, 2024
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.
XiaoBai
XiaoBai frees your mind of having to remember things you need to do. It's,
FASTSUPER FAST to useAll you need to do is,
And it is FREE!
Features:
If you are a Java programmer, you can use it to practice Java too. Here's the main method: