Add some docstrings / comments explainning each sorting algorithm

[LucasPilla]

Please, choose an avaiable algorithm and comment it's name before you start working.

Algorithms:

• [ ] bogoSort
• [ ] bitonicSort
• [ ] binaryinsertionSort
• [ ] bubbleSort
• [ ] heapSort
• [ ] gnomeSort
• [ ] cycleSort
• [ ] countingSort
• [ ] combSort
• [ ] cocktailSort
• [ ] bucketSort
• [ ] timSort
• [ ] strandSort
• [ ] stoogeSort
• [ ] shellSort
• [ ] selectionSort
• [ ] quickSort
• [ ] pigeonholeSort
• [ ] pancakeSort
• [ ] oddevenSort
• [ ] mergeSort
• [ ] insertionSort
• [ ] radixSort
• [ ] treeSort
• [ ] exchangeSort

[lucasrafaldini]

Hey, I want to contribute with binaryinsertionSort docstrings.

[lucasrafaldini]

I took the liberty to also make the docstrings for bitonicSort. Here's the PR -> https://github.com/LucasPilla/Sorting-Algorithms-Visualizer/pull/165

[lucasrafaldini]

Hey guys.

I took advantage of the holidays in Brazil and wrote docstrings for all algorithms. I hope it helps. I tried to keep a certain "standard" but sometimes I didn't know everything about it or just didn't know anything to write about but I think they are a good starting point.

[LucasPilla]

@lucasrafaldini I will have a look asap, thanks! 😄

[Velin-Todorov]

Hi. Is this issue still open? Are there algorithms that still need comments/docstrings?

[LucasPilla]

@Velin-Todorov, @lucasrafaldini did a great job :wave: but there are some tasks to be done:

• maybe it is better if we keep the docstrings 1 or 2 paragraphs long.
• add a simple table with time and space complexity for each algorithm.
• remove the "Args" and "Yields" parts, they are not useful at all

What do you think?

[Velin-Todorov]

It sounds great. Please assign this to me. Where can i find the docstrings?

Also, could you please provide me with a deadline?

Kind regards,

Velin

[LucasPilla]

@Velin-Todorov I just merged the pull request made by @lucasrafaldini.

• Now you can find the docstrings in this repository (src/algorithms).
• Take your time and fell free to ask anything.

[raghavaraghav3]

@Velin-Todorov, @lucasrafaldini did a great job 👋 but there are some tasks to be done:

• maybe it is better if we keep the docstrings 1 or 2 paragraphs long.
• add a simple table with time and space complexity for each algorithm.
• remove the "Args" and "Yields" parts, they are not useful at all

What do you think?

Hey @LucasPilla can you also assign this to me?? I can work on some of the algorithms.

Thanks, Ven

[Velin-Todorov]

@Velin-Todorov, @lucasrafaldini did a great job 👋 but there are some tasks to be done:

• maybe it is better if we keep the docstrings 1 or 2 paragraphs long.
• add a simple table with time and space complexity for each algorithm.
• remove the "Args" and "Yields" parts, they are not useful at all

What do you think?

Hey @LucasPilla can you also assign this to me?? I can work on some of the algorithms.

Thanks, Ven

@Velin-Todorov, @lucasrafaldini did a great job 👋 but there are some tasks to be done:

• maybe it is better if we keep the docstrings 1 or 2 paragraphs long.
• add a simple table with time and space complexity for each algorithm.
• remove the "Args" and "Yields" parts, they are not useful at all

What do you think?

Hey @LucasPilla can you also assign this to me?? I can work on some of the algorithms.

Thanks, Ven

Hi Ven. I prefer to work this task alone.

Kind regards,

Velin

[Velin-Todorov]

@LucasPilla I have finished editing the docstrings. Let me know what you think. Tomorrow I will add the table with the complexities as well.

[Alex-Wengg]

Hey @ Velin-Todorov, are any contributions left for this issue?

[brkuhgk]

@Velin-Todorov can you highlight the sorting algorithms which are not contributed.