Sharing iP code quality feedback [for @Sornsornah]

[soc-se-bot]

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

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/pixel/Parser.java lines 140-146:

    /**
     * Act based on command given from the user's input
     *
     * @param command command obtained from Ui
     * @param tasks TaskList for processing of tasks
     * @param storage Storage for processing of files
     */

Example from src/main/java/pixel/Task.java lines 20-22:

    /**
     * Mark Task as done and changing status to completed
     */

Example from src/main/java/pixel/Task.java lines 27-29:

    /**
     * Mark Task as undone and changing status to incomplete
     */

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 86a170e:

Merge branch 'branch-B-ViewSchedules'
User cannot search deadlines based on dates

For user to better see their deadlines for the day to see
what they need to do, they need to have a feature to view the
given date's deadlines

Let's add a view command and the date after to display the user's
deadlines for that day

By making the format simple without excluding the time, the user
will be better able to see the tasks available

Events can be added by comparing the given date and ensuring that
it is between from and to so

• No blank line between subject and body

possible problems in commit 3ba4eb1:

Merge branch 'branch-A-Assertions'
deadline and event command: require splitting to format the arguments

Splitting gives wrong formatting if there is wrong input

Let's assert to make sure that the split stringArray has the correct length

If the dates are left blank or in the wrong format, the stringArary will not be of the correct length and the program will not run.

• No blank line between subject and body
• body not wrapped at 72 characters: e.g., Let's assert to make sure that the split stringArray has the correct length

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 cs2103@comp.nus.edu.sg if you want to follow up on this post.