Git Product home page Git Product logo

ip's Introduction

Paimon User Guide

Paimon User Interface

Paimon is a versatile task manager designed to help you keep track of your tasks efficiently. With a user-friendly graphical user interface (GUI), Paimon simplifies task management, allowing you to add, delete, mark tasks as done or undone, and search for tasks with ease. Below is a comprehensive guide to Paimon's features, ensuring you get the most out of your task manager.

List Tasks

Description: Displays all your tasks in a list.

Usage Example: list

Expected Outcome:

1. [T][ ] Read a book
2. [D][X] Submit assignment (by: Mar 10)
3. [E][ ] Project meeting (from: Mar 11, 10am to: Mar 11, 11am)

Add a Todo Task

Description: Adds a task without any deadline.

Usage Example: todo Read a book

Expected Outcome:

Added: [T][ ] Read a book

Add a Deadline

Description: Adds a task with a deadline.

Usage Example: deadline Submit assignment /by Mar 10

Expected Outcome:

Added: [D][ ] Submit assignment (by: Mar 10)

Add an Event

Description: Adds a task with a start and end time.

Usage Example: event Project meeting /from Mar 11, 10am /to Mar 11, 11am

Expected Outcome:

Added: [E][ ] Project meeting (from: Mar 11, 10am to: Mar 11, 11am)

Mark a Task as Done

Description: Marks a task as completed.

Usage Example: mark 2

Expected Outcome:

Marked as done: [D][X] Submit assignment (by: Mar 10)

Unmark a Task

Description: Marks a completed task as not done.

Usage Example: unmark 2

Expected Outcome:

Marked as not done: [D][ ] Submit assignment (by: Mar 10)

Delete a Task

Description: Deletes a task from your list.

Usage Example: delete 1

Expected Outcome:

Deleted: [T][ ] Read a book

Find Tasks by Keyword

Description: Lists all tasks that contain a specific keyword.

Usage Example: find book

Expected Outcome:

[T][ ] Read a book

Exit the Program

Description: Safely exits Paimon.

Usage Example: bye

Expected Outcome:

Goodbye! Hope to see you again soon!

Add a Task with a Start Time

Description: Adds a task that must be started after a specific time.

Usage Example: doafter Email professor /from Mar 12

Expected Outcome:

Added: [T][ ] Email professor (after: Mar 12)

This user guide aims to make your experience with Paimon as smooth and productive as possible. Whether you're managing daily tasks or planning for future events, Paimon is here to assist you every step of the way.

ip's People

Contributors

jovantanyk avatar j-lum avatar damithc avatar seanleong339 avatar jiachen247 avatar eclipse-dominator avatar

ip's Issues

Sharing iP code quality feedback [for @jovantanyk]

@jovantanyk We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, to help you improve the iP code further.

IMPORTANT: Note that the script looked for just a few easy-to-detect problems only, and at-most three example are given i.e., there can be other areas/places to improve.

Aspect: Tab Usage

No easy-to-detect issues ๐Ÿ‘

Aspect: Naming boolean variables/methods

No easy-to-detect issues ๐Ÿ‘

Aspect: Brace Style

No easy-to-detect issues ๐Ÿ‘

Aspect: Package Name Style

No easy-to-detect issues ๐Ÿ‘

Aspect: Class Name Style

No easy-to-detect issues ๐Ÿ‘

Aspect: Dead Code

No easy-to-detect issues ๐Ÿ‘

Aspect: Method Length

Example from src/main/java/paimon/util/CommandParser.java lines 64-148:

    public Command parseInput() throws ChatException {
        switch (this.type) {
        case "bye":
            return new ExitCommand();
        case "list":
            return new ListCommand();
        case "help":
            return new HelpCommand();
        case "todo":
            String todoRegex = "^(\\w+)(\\s)(.+)";
            Pattern todoPattern = Pattern.compile(todoRegex);
            Matcher todoMatcher = todoPattern.matcher(input);
            if (todoMatcher.find()) {
                String description = todoMatcher.group(3);
                return new TodoCommand(description);
            } else {
                throw new ChatException("Input does not match expected format: todo <task>");
            }
        case "deadline":
            String deadlineRegex = "^(\\w+) (.+?)\\/by (.+)$";
            Pattern deadlinePattern = Pattern.compile(deadlineRegex);
            Matcher deadlineMatcher = deadlinePattern.matcher(input);
            if (deadlineMatcher.find()) {
                String description = deadlineMatcher.group(2);
                String toTime = deadlineMatcher.group(3);
                return new DeadlineCommand(description, toTime);
            } else {
                throw new ChatException("Input does not match expected format: deadline <task> /by <time>");
            }
        case "event":
            String eventRegex = "^(\\w+) (.+?) \\/from (.+?) \\/to (.+)$";
            Pattern eventPattern = Pattern.compile(eventRegex);
            Matcher eventMatcher = eventPattern.matcher(input);
            if (eventMatcher.find()) {
                String description = eventMatcher.group(2);
                String fromTime = eventMatcher.group(3);
                String toTime = eventMatcher.group(4);
                return new EventCommand(description, fromTime, toTime);
            } else {
                throw new ChatException("Input does not match expected format: event <task> /from <time> /to <time>");
            }
        case "mark":
            String markRegex = "^(\\w+) (\\d+)";
            Pattern markPattern = Pattern.compile(markRegex);
            Matcher markMatcher = markPattern.matcher(input);
            if (markMatcher.find()) {
                String number = markMatcher.group(2);
                return new MarkCommand(number);
            } else {
                throw new ChatException("Input does not match expected format: mark <number>");
            }
        case "unmark":
            String unmarkRegex = "^(\\w+) (\\d+)";
            Pattern unmarkPattern = Pattern.compile(unmarkRegex);
            Matcher unmarkMatcher = unmarkPattern.matcher(input);
            if (unmarkMatcher.find()) {
                String number = unmarkMatcher.group(2);
                return new UnmarkCommand(number);
            } else {
                throw new ChatException("Input does not match expected format: unmark <number>");
            }
        case "delete":
            String deleteRegex = "^(\\w+) (\\d+)";
            Pattern deletePattern = Pattern.compile(deleteRegex);
            Matcher deleteMatcher = deletePattern.matcher(input);
            if (deleteMatcher.find()) {
                String number = deleteMatcher.group(2);
                return new DeleteCommand(number);
            } else {
                throw new ChatException("Input does not match expected format: delete <number>");
            }
        case "find":
            String findRegex = "^(\\w+)(\\s)(.+)";
            Pattern findPattern = Pattern.compile(findRegex);
            Matcher findMatcher = findPattern.matcher(input);
            if (findMatcher.find()) {
                String keyword = findMatcher.group(3);
                return new FindCommand(keyword);
            } else {
                throw new ChatException("Input does not match expected format: find <keyword>");
            }
        default:
            throw new ChatException("Command not found, type help for a list of commands");
        }
    }

Suggestion: Consider applying SLAP (and other abstraction mechanisms) to shorten methods e.g., extract some code blocks into separate methods. You may ignore this suggestion if you think a longer method is justified in a particular case.

Aspect: Class size

No easy-to-detect issues ๐Ÿ‘

Aspect: Header Comments

Example from src/main/java/paimon/Paimon.java lines 16-20:

    /**
     * The main method that starts the application.
     * It performs initial setup by greeting the user, loading the task list from a file,
     * and then enters a loop to process user commands until an exit command is issued.
     */

Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.

Aspect: Recent Git Commit Message

possible problems in commit 6c70b7e:


Merge A-CheckStyle to master

Implement Checkstyle and ensure that all files follow java conventions. Indentations are now consistent and import statements are ordered accordingly.


  • body not wrapped at 72 characters: e.g., Implement Checkstyle and ensure that all files follow java conventions. Indentations are now consistent and import statements are ordered accordingly.

possible problems in commit 2f245c9:


Merge A-CodingStandard to master branch

Edit and implement various coding standards to adhere to java coding conventions. This includes optimising import statements, indentation and more consistent method names.


  • body not wrapped at 72 characters: e.g., Edit and implement various coding standards to adhere to java coding conventions. This includes optimising import statements, indentation and more consistent method names.

possible problems in commit 0271e63:


style: improve imports

Improve imports by reducing the use of wildcard imports. This helps with reducing bloat as only the needed classes are imported


  • body not wrapped at 72 characters: e.g., Improve imports by reducing the use of wildcard imports. This helps with reducing bloat as only the needed classes are imported

Suggestion: Follow the given conventions for Git commit messages for future commits (do not modify past commit messages as doing so will change the commit timestamp that we used to detect your commit timings).

Aspect: Binary files in repo

No easy-to-detect issues ๐Ÿ‘


โ„น๏ธ The bot account used to post this issue is un-manned. Do not reply to this post (as those replies will not be read). Instead, contact [email protected] if you want to follow up on this post.

Sharing iP code quality feedback [for @jovantanyk] - Round 2

@jovantanyk We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, so that you can avoid similar problems in your tP code (which will be graded more strictly for code quality).

IMPORTANT: Note that the script looked for just a few easy-to-detect problems only, and at-most three example are given i.e., there can be other areas/places to improve.

Aspect: Tab Usage

No easy-to-detect issues ๐Ÿ‘

Aspect: Naming boolean variables/methods

No easy-to-detect issues ๐Ÿ‘

Aspect: Brace Style

No easy-to-detect issues ๐Ÿ‘

Aspect: Package Name Style

No easy-to-detect issues ๐Ÿ‘

Aspect: Class Name Style

No easy-to-detect issues ๐Ÿ‘

Aspect: Dead Code

No easy-to-detect issues ๐Ÿ‘

Aspect: Method Length

No easy-to-detect issues ๐Ÿ‘

Aspect: Class size

No easy-to-detect issues ๐Ÿ‘

Aspect: Header Comments

No easy-to-detect issues ๐Ÿ‘

Aspect: Recent Git Commit Message

possible problems in commit f234366:


fix: remove unnecessary file

Remove unnecessary temporary file paimon.txt from the repo

The file paimon.txt is a temporary storage file that currently exists in the repository.

Remove the unnecessary file paimon.txt to clean up the repository and reduce clutter.

paimon.txt was already included in the .gitignore but for some reason was still being committed


  • body not wrapped at 72 characters: e.g., The file paimon.txt is a temporary storage file that currently exists in the repository.

possible problems in commit c8b00e5:


fix: update doafter format

Update the doafter command to align with documentation expectations

The doafter command's current implementation deviates from the documented expected output, leading to confusion and mismatches in user expectations.

Modify the doafter command to ensure its output matches the expectations set forth in the documentation.


  • body not wrapped at 72 characters: e.g., The doafter command's current implementation deviates from the documented expected output, leading to confusion and mismatches in user expectations.

possible problems in commit 2c81fb4:


docs: standardise datetime output

Update documentation to match actual program output

The existing documentation's time format descriptions do not align with the standardized output format used by the program.

Update the documentation to reflect the standardized time format across all examples and explanations.

Standardizing the time format in the documentation ensures consistency with the program's output, reducing confusion and improving user comprehension. This change is made to align documentation closely with the actual behavior of the program, ensuring that users have accurate expectations and understand how to interpret the output correctly.


  • body not wrapped at 72 characters: e.g., The existing documentation's time format descriptions do not align with the standardized output format used by the program.

Suggestion: Follow the given conventions for Git commit messages for future commits (do not modify past commit messages as doing so will change the commit timestamp that we used to detect your commit timings).

Aspect: Binary files in repo

No easy-to-detect issues ๐Ÿ‘


โ— You are not required to (but you are welcome to) fix the above problems in your iP, unless you have been separately asked to resubmit the iP due to code quality issues.

โ„น๏ธ The bot account used to post this issue is un-manned. Do not reply to this post (as those replies will not be read). Instead, contact [email protected] if you want to follow up on this post.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.