lwlshawn / ip Goto Github PK

View Code? Open in Web Editor NEW

This project forked from nus-cs2103-ay2122s1/ip

0.0 0.0 0.0 1.65 MB

Java 96.04% Batchfile 1.67% Shell 2.29%

ip's Introduction

User Guide

This is the user guide for Frosty! The (slightly) Christmas themed task manager that is happy to assist you.

Features

Adding tasks

The application allows you to add the following types of tasks:

Todo
Deadline
Event

Deadline and Event tasks have an added functionality of allowing you to add a date.

Saving tasks

You can input a save command into the application to save your list for future use! If saved data is found, your previous session will be loaded into the application automatically.

Other task related utilities:

The application also comes with the following list of helpful functions to aid you in managing your tasks:

Finding tasks related to a keyword
Deleting tasks from the list
Update the date/label of a task conveniently

Usage

To close the application, simply click on the X at the top right-hand! Below, the various other functions supported are demonstrated; so the expected outcome reflects what should happen if you sequentially key in all the commands under "example usage" below.

`todo` - Adds a Todo task to the list

Example of usage:

todo check giftlist

Expected outcome:

Got it. I've added this task:
  [T][] check giftlist
Now you have 1 tasks in the list.

`deadline` - Adds a Deadline task to the list

Example of usage:

deadline make gifts /by 2020-12-20

Expected outcome:

Got it. I've added this task:
  [D][] make gifts (by: Dec 20 2020)
Now you have 2 tasks in the list.

`event` - Adds a Event task to the list

Example of usage:

event train raindeers to fly /at 2020-12-01

Expected outcome:

Got it. I've added this task:
  [E][] train raindeers to fly (at: Dec 1 2020)
Now you have 3 tasks in the list.

`list` - Displays the current list of tasks

Example of usage:

list

Expected outcome:

Here are the tasks in your list:
[T][] check giftlist
[D][] make gifts (by: Dec 20 2020)
[E][] train raindeers to fly (at: Dec 1 2020)

`done` - Marks a task as done

Example of usage:

done 1

Expected outcome:

The relevant task in the list will have its checkbox marked with an X

Nice! I've marked this task as done:
[T][X] check giftlist

`save` - Saves tasklist for future sessions

Example of usage:

save

Expected outcome:

Your list has been saved!

`find` - Searches for tasks related to given prompt

Example of usage:

find gift

Expected outcome:

Here are the matching tasks in your list:
[T][X] check giftlist
[D][] make gifts (by: Dec 20 2020)

`delete` - Deletes a task from the list

Example of usage:

delete 3

Expected outcome:

Noted. I've removed this task:
  [E][] train raindeers to fly (at: Dec 1 2020)
Now you have 2 tasks in the lsit.

`update` - Update either the label or date of a task

Example of usage:

update 1 create giftlist

Expected outcome:

I've updated your selected task to: 
  [T][] create giftlist

Example of usage:

update date 2 2021-12-10

Expected outcome:

I've updated your selected task to:
  [D][] make gifts (by: Dec 20 2021)

ip's People

Contributors

ip's Issues

Sharing iP code quality feedback [for @lwlshawn]

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 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

Example from src/main/java/duke/task/Task.java lines 12-12:

    private boolean flag;

Suggestion: Follow the given naming convention for boolean variables/methods

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: Header Comments

Example from src/main/java/duke/Duke.java lines 16-19:

    /**
     * Initial startup code and loading from saved data if found is done here. Saved data filename and location is
     * hardcoded in this implementation. data folder will be created if none exists.
     */

Example from src/main/java/duke/Storage.java lines 27-31:

    /**
     * When a Storage object is initialised, it will create the data directory in the source directory.
     * Currently filename represents where the data is to be saved, and it is hard-coded in Duke.java.
     * @param filename is the file the application will write to, in the data folder.
     */

Example from src/main/java/duke/Storage.java lines 42-48:

    /**
     * Load locates the saved data if it exists, and parses it to create a TaskList representing the saved sessions
     * data. Uses a Ui object to print notices informing a user if errors occur, when the load begins, and when it ends.
     * @return a list of tasks saved from previous session.
     * @throws IOException if initialising the reader fails, or reading from the save data causes an error.
     * @throws DukeException if the saved data has a format that is not recognised.
     */

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 (Subject Only)

No easy-to-detect issues 👍

ℹ️ The bot account @cs2103-bot 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 @lwlshawn] - Round 2

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

Example from src/main/java/duke/Ui.java lines 10-12:

    /**
     * Method called at beginning of application run. Prints welcome message.
     */

Example from src/main/java/duke/task/Task.java lines 24-28:

    /**
     * Method used to mark the task as done.
     *
     * @param isDone Indicates whether the task is marked as done.
     */

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 (Subject Only)

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 @nus-se-bot 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.

lwlshawn / ip Goto Github PK

ip's Introduction

User Guide

Features

Adding tasks

Saving tasks

Other task related utilities:

Usage

todo - Adds a Todo task to the list

deadline - Adds a Deadline task to the list

event - Adds a Event task to the list

list - Displays the current list of tasks

done - Marks a task as done

save - Saves tasklist for future sessions

find - Searches for tasks related to given prompt

delete - Deletes a task from the list

update - Update either the label or date of a task

ip's People

Contributors

ip's Issues

Aspect: Tab Usage

Aspect: Naming boolean variables/methods

Aspect: Brace Style

Aspect: Package Name Style

Aspect: Class Name Style

Aspect: Dead Code

Aspect: Method Length

Aspect: Header Comments

Aspect: Recent Git Commit Message (Subject Only)

Aspect: Tab Usage

Aspect: Naming boolean variables/methods

Aspect: Brace Style

Aspect: Package Name Style

Aspect: Class Name Style

Aspect: Dead Code

Aspect: Method Length

Aspect: Class size

Aspect: Header Comments

Aspect: Recent Git Commit Message (Subject Only)

Recommend Projects

Recommend Topics

Recommend Org

`todo` - Adds a Todo task to the list

`deadline` - Adds a Deadline task to the list

`event` - Adds a Event task to the list

`list` - Displays the current list of tasks

`done` - Marks a task as done

`save` - Saves tasklist for future sessions

`find` - Searches for tasks related to given prompt

`delete` - Deletes a task from the list

`update` - Update either the label or date of a task