Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added CombSortTest.java #825

Open
wants to merge 2 commits into
base: Development
from
Open

Conversation

@jayyusi
Copy link

@jayyusi jayyusi commented Sep 14, 2019

copied over CombSort.java from master branch to Development branch.
Added CombSortTest.java to Development branch

copied over CombSort.java from master branch to Development branch.
Added CombSortTest.java to Development branch
Copy link

@SirWindfield SirWindfield left a comment

This should fix some naming and formatting errors to match with Java's coding style.


class CombSortTest {

//One global combSort instance variable

This comment has been minimized.

@SirWindfield

SirWindfield Sep 15, 2019

The comment can be removed, not really needed.

This comment has been minimized.

@jayyusi

jayyusi Sep 15, 2019
Author

done.

//One global combSort instance variable
CombSort combSort = new CombSort();

//Integer Sort Test

This comment has been minimized.

@SirWindfield

SirWindfield Sep 15, 2019

Same goes here. The naming scheme of your methods should be testSomething. Like testIntegerSort and testStringSort. Methods in Java start with a lowercase letter. Make sure to correct that everywhere else too.

This comment has been minimized.

@jayyusi

jayyusi Sep 15, 2019
Author

how about combSortIntegerTest ?

This comment has been minimized.

@SirWindfield

SirWindfield Sep 15, 2019

No, just change it to testStringSort and testIntegerSort. Your class is named CombSortTest already, no need to add it to the method names. Alongside that, all test methods from the other classes are named using the testXXX scheme. And to keep consistency it would be better if you could change them too :)

This comment has been minimized.

@jayyusi

jayyusi Sep 15, 2019
Author

CycleSortTest class does not follow the consistency you mentioned ?!
it follows what I suggested :)
class CycleSortTest {

@Test
void cycleSortIntegerTest() {

    CycleSort cycleSort = new CycleSort();

This comment has been minimized.

@SirWindfield

SirWindfield Sep 15, 2019

If you take a look at all the other tests, they follow the convention testXXX where XXX gives some details of what is being tested. In your case, it would be testStringSort or something similar.

Edit:
Well, looks like some tests need a rename then :) They shouldn't be named like that though. Even the JUnit site lists the testXXX naming scheme as a go-to. And in all Java based open source projects I worked on they mostly used that scheme.

Well, I am in no position to force you to use it, I'm no member of this organisation. At least make the method names lowercase please. Because THAT is Java convention.

This comment has been minimized.

@jayyusi

jayyusi Sep 15, 2019
Author

haha, yes now you see what I mean, and now I see what you mean, I just noticed in the /search folder, the tests follow the naming convention of testXXX.

I did the changes, did you want me to also remove all the comments like this one:
//Integer Sort Test

I'm almost done, and thank you for the review and the edit suggestions. Its always good to have another pair of eyes. I admit I totally overlooked the method names.

This comment has been minimized.

@SirWindfield

SirWindfield Sep 15, 2019

Would be nice if you could remove any comments that don't really add value, yes. If they are needed to explain why a certain thing is done, let them in. But something like // Integer Sort test is not really needed.

No problem :)

This comment has been minimized.

@jayyusi

jayyusi Sep 15, 2019
Author

alright, done.
I made a commit to the same pull request.
Do you know when will pull requests be merged with the development branch ?

This comment has been minimized.

@SirWindfield

SirWindfield Sep 15, 2019

It usually takes some time...


//compare the two results, our CombSort vs. Java's sort
Assertions.assertArrayEquals(array1,array2);

This comment has been minimized.

@SirWindfield

SirWindfield Sep 15, 2019

Remove empty lines at the end of each method.

This comment has been minimized.

@jayyusi

jayyusi Sep 15, 2019
Author

done.


//Integer Sort Test
@Test
void CombSortIntegerTest(){

This comment has been minimized.

@SirWindfield

SirWindfield Sep 15, 2019

Method name, see above.


//String Sort Test
@Test
void CombSortStringTest(){

This comment has been minimized.

@SirWindfield

SirWindfield Sep 15, 2019

Method name, see above.

removed unnecessary comments
removed blank lines at end of method
modified method names
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.