[jellywaiyan] iP#538
Open
jellywaiyan wants to merge 52 commits into
Open
Conversation
# Conflicts: # src/main/java/Jelly/main/Storage.java # src/main/java/Jelly/main/TaskList.java # src/main/java/Jelly/main/Ui.java # src/main/java/Jelly/task/Deadline.java # src/main/java/Jelly/task/Event.java # src/main/java/Jelly/task/Todo.java
# Conflicts: # src/main/java/Jelly/main/Jelly.java # src/main/java/Jelly/main/Ui.java
yiwen101
reviewed
Sep 7, 2023
yiwen101
left a comment
There was a problem hiding this comment.
Looks good
Quite comprehensive documentation
Well designed
| } | ||
|
|
||
| @Override | ||
| public String writeToFile() { |
There was a problem hiding this comment.
Could be better named.
I do not expect"writeToFile" to be a method that returns the String to be written
| /** | ||
| * The main initialiser for the Jelly Chat bot. | ||
| * | ||
| * @param args |
There was a problem hiding this comment.
I do not think "@param args" help much
And I believe that you do not need to document every method as well.
| /** | ||
| * Prints out a welcome message when the Chat Bot is booted up. | ||
| */ | ||
| public void startUpMessage() { |
| * @param addedTask The task that was added. | ||
| * @param noOfTasks The total number of tasks in the list after adding. | ||
| */ | ||
| public void addedTaskMessage(Task addedTask, int noOfTasks) { |
| /** | ||
| * Displays a final message to the user before the Chat Bot shuts down. | ||
| */ | ||
| public void byeMessage() { |
| * Should not happen, as tasks should be either one of these: todo, deadline or event. | ||
| * @return Error message. | ||
| */ | ||
| public String writeToFile() { |
There was a problem hiding this comment.
if this should not happen, why not throw exception when called?
ElginTZM
reviewed
Sep 8, 2023
Comment on lines
+11
to
+15
| private String description; | ||
|
|
||
| private String fromWhen; | ||
|
|
||
| private String toWhen; |
Comment on lines
+4
to
+9
| import Jelly.task.Task; | ||
| import Jelly.task.Todo; | ||
| import org.junit.jupiter.api.Test; | ||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
| import static org.junit.jupiter.api.Assertions.assertFalse; |
There was a problem hiding this comment.
Perhaps you can separate out the imports?
|
|
||
| public class StorageTest { | ||
| @Test | ||
| public void startUpTest() throws IOException, JellyException { |
There was a problem hiding this comment.
Test methods name can utilize another convention for naming them: featureUnderTest_testScenario_expectedBehavior()
Delete command: Save to file after deleting Mark command: Save to file after marking a task as done Unmark command: Save to file after marking a task as not done Previously, these commands did not save to file, which caused the file to be outdated. Let's, *add a saveToFile method after completing the command
Improve code quality by making methods more efficient and readable.
Assert feature allows the documentation of important assumptions that should hold at various points in the code. Let's, *add assertions in Task, Parser,DeleteCommand, MarkCommand, UnmarkCommand.
Current implementation does not use assertions.
This file contains hidden or 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
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.
Jelly
Jelly frees your mind of having to remember things you need to do. It's,
FASTMAYBE FAST to use :oAll 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
mainmethod: