[W7][T08-4]Sonia Sunil #20
Conversation
(Previous PR to master branch to reject)
There was a problem hiding this comment.
Hi Sonia,
Good effort here. You have updated the user guide and provided a enhancement. Some areas you could improve on:
(1) Observing header conventions. Each new non-trivial method that you add should be accompanied with header comments telling what is the functionality of this method and the sentence should begin with a verb e.g. Performs sorting of names in addressbook.
(2) Proving test functionality. For every enhancement, you could provided a unit test to test the new functionality, to demonstrate for each given input, the expected output matches the actual output of new method.
You may close this PR after reviewing this comment.
| @@ -39,12 +39,12 @@ public static String getMessageForPersonListShownSummary(List<? extends ReadOnly | |||
| /** | |||
| * Executes the command and returns the result. | |||
| */ | |||
| public CommandResult execute(){ | |||
| /*public CommandResult execute(){ | |||
There was a problem hiding this comment.
Avoid leaving unnecessary block comments in your code like this one.
| @@ -61,6 +62,11 @@ public Address getAddress() { | |||
| return new HashSet<>(tags); | |||
| } | |||
|
|
|||
There was a problem hiding this comment.
Missing header comment. All non-trivial methods should have java doc format header comments.
| @@ -44,6 +44,11 @@ public static boolean isValidName(String test) { | |||
| return Arrays.asList(fullName.split("\\s+")); | |||
| } | |||
|
|
|||
| public int compareName(Name a){ | |||
There was a problem hiding this comment.
Missing header comment. All non-trivial methods should have java doc format header comments.
| @@ -58,6 +58,15 @@ public void removePerson(ReadOnlyPerson toRemove) throws PersonNotFoundException | |||
| allPersons.remove(toRemove); | |||
| } | |||
|
|
|||
| /** | |||
| * to sort the list of people in the address book | |||
| */ | |||
There was a problem hiding this comment.
A minor point - Note the header conventions in your next submission, it should start with a verb. E.g. Sorts the list of people in the address book.
This is a Sort Command that will show the addressbook in alphabetically sorted order.