Improve code quality #304
Merged
Improve code quality #304
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
* 'master' of github.com:AY2324S2-CS2103T-W10-2/tp: Fix pin edit bug
yleeyilin
requested review from
Joshy837,
chiageng,
jannaleong and
jamessinmaojun
jamessinmaojun
approved these changes
Apr 13, 2024
There was a problem hiding this comment.
Just a few comments from me, otherwise lgtm!
- There are many repeated comments and I have tried my best to comment at all occurrences of the repeated errors, however I may have missed a few so please check through all again.
requireNonNullseems to be used in conjunction withassertfor a few commands, but are missing for other commands. Might want to standardise this.
| @@ -35,30 +35,44 @@ public class AddCommandParser implements Parser<AddCommand> { | |||
|
|
|||
| /** | |||
| * Parses the given {@code String} of arguments in the context of the AddCommand | |||
| * and returns an AddCommand object for execution. | |||
| * and returns an AddCommand object for execution. Parameter args cannot be null. | |||
There was a problem hiding this comment.
should be @{code args} instead of 'args'
| @@ -39,31 +39,46 @@ public class AddMaintainerCommandParser implements Parser<AddMaintainerCommand> | |||
| private final Logger logger = LogsCenter.getLogger(getClass()); | |||
| /** | |||
| * Parses the given {@code String} of arguments in the context of the AddStaffCommand | |||
| * and returns an AddCommand object for execution. | |||
| * and returns an AddCommand object for execution. Parameter args cannot be null. | |||
| @@ -39,31 +39,46 @@ public class AddStaffCommandParser implements Parser<AddStaffCommand> { | |||
|
|
|||
| /** | |||
| * Parses the given {@code String} of arguments in the context of the AddStaffCommand | |||
| * and returns an AddCommand object for execution. | |||
| * and returns an AddCommand object for execution. Parameter args cannot be null. | |||
| @@ -38,29 +38,44 @@ public class AddSupplierCommandParser implements Parser<AddSupplierCommand> { | |||
| private final Logger logger = LogsCenter.getLogger(getClass()); | |||
| /** | |||
| * Parses the given {@code String} of arguments in the context of the AddStaffCommand | |||
| * and returns an AddCommand object for execution. | |||
| * and returns an AddCommand object for execution. Parameter args cannot be null. | |||
| @@ -23,30 +23,32 @@ public class DeleteCommandParser implements Parser<DeleteCommand> { | |||
|
|
|||
| /** | |||
| * Parses the given {@code String} of arguments in the context of the DeleteCommand | |||
| * and returns a DeleteCommand object for execution. | |||
| * and returns a DeleteCommand object for execution. Parameter args cannot be null. | |||
| @@ -26,28 +26,30 @@ public class RateCommandParser implements Parser<RateCommand> { | |||
|
|
|||
| /** | |||
| * Parses the given {@code String} of arguments in the context of the RateCommand | |||
| * and returns a RateCommand object for execution. | |||
| * and returns a RateCommand object for execution. Parameter args cannot be null. | |||
| @@ -26,28 +26,30 @@ public class RateCommandParser implements Parser<RateCommand> { | |||
|
|
|||
| /** | |||
| * Parses the given {@code String} of arguments in the context of the RateCommand | |||
| * and returns a RateCommand object for execution. | |||
| * and returns a RateCommand object for execution. Parameter args cannot be null. | |||
| * | |||
| * @throws ParseException if the user input does not conform the expected format | |||
There was a problem hiding this comment.
same comment here on missing preposition "to"
| logger.log(Level.INFO, "Going to start parsing for rate command."); | ||
| ArgumentMultimap argMultimap = ArgumentTokenizer.tokenize(args, PREFIX_NAME, PREFIX_RATING); |
There was a problem hiding this comment.
should have empty line before this to separate from logging code block
| @@ -17,34 +17,30 @@ public class SearchCommandParser implements Parser<SearchCommand> { | |||
|
|
|||
| /** | |||
| * Parses the given {@code String} of arguments in the context of the SearchCommand | |||
| * and returns a SearchCommand object for execution. | |||
| * and returns a SearchCommand object for execution. Parameter args cannot be null. | |||
| * @throws ParseException if the user input does not conform the expected format | |||
There was a problem hiding this comment.
same comment here on missing preposition "to"
| * Parses the given {@code String} of arguments in the context of the PinCommand | ||
| * and returns an PinCommand object for execution. | ||
| * Parses the given {@code String} of arguments in the context of the UnpinCommand | ||
| * and returns an UnpinCommand object for execution. Parameter args cannot be null. |
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.
Improve code quality by adding assert statements.
I also helped to standardise commenting and code separations.