first challenge with quick_sort function

JumongEric commented 10 months ago

QuickSort is a popular and efficient sorting algorithm that follows the divide-and-conquer paradigm. The basic idea behind QuickSort is to select a "pivot" element from the array and partition the other elements into two sub-arrays according to whether they are less than or greater than the pivot. The process is then applied recursively to the sub-arrays.

tvsirius commented 10 months ago

You should not have deleted the check list that was here

I will put it back

tvsirius commented 10 months ago

[x] PR's title includes the challenge's name and language
[x] PR has short and clear description of the challenge
[x] PR has appropriate labels and milestones for easy identification
[x] PR it is assigned to the owner
[x] reviewers are assigned
[x] the PR contributes only one focused change
[x] the branch is up to date with main/master
[x] the code works when pulled and run locally
[x] all conflicts are resolved (if any)
[x] It is linked to an issue in the appropriate column of the project board
[x] feedback is addressed (if any, and if it is appropriate feedback.)

README Documentation

[x] The solution is documented in /src/README.md
[x] The markdown source is formatted
[x] Spelling and grammar is correct in all text
[x] The markdown looks correct when you preview the file
[x] All links and images work
[x] The README documents the solution's behavior, strategy(ies) and implementation(s)
[x] There are use cases in code blocks to illustrate the function's behavior

Python Files

[ ] There is a module header
[ ] There is a module docstring
[x] File names are in snake_case
[x] Test files are named test_<module_name>.py

Function Docstring

[x] Behavior description
[x] Parameter description
[x] Return value description
[x] Include any assumptions
[x] Include 3 or more (passing!) doctests
[ ] Include 1-2 use cases (if necessary)

Function Implementation

[x] The solution is not is not copied from djeada
[x] The code is auto-formatted
[x] The code has no (reasonable) linting mistakes
[x] Variables are named with snake_case
[x] The function has a clear and helpful name
[x] The file's name matches the function name
[x] The code follows the strategy as simply as possible
[x] Variable names are clear and helpful
[x] Comments explain the strategy (if necessary)
[x] There are type annotations
[ ] (challenge) The code includes defensive assertions

Unit Test Suite

[x] The test class has a helpful name in PascalCase
[ ] The test class has a docstring
Each unit test has
- [x] A helpful name
- [ ] A clear docstring
- [x] Only one assertion
[x] All tests pass
[ ] There are tests for defensive assertions
[ ] There are tests for boundary cases
[ ] Test suite includes black-box and glass-box tests

tvsirius commented 10 months ago

add README.md add working test_quick_sort when i pull your branch i have to fix it, with

from quick_sort import quick_sort

tvsirius commented 10 months ago

Code is good and working, but it could be made better

You are missing: module and test docstrings type annotaions comments marking zero case and it would be better to add coments on logic use auto formatter (it's easy, just install autoPEP8 and press Shift-Alt-F in VSCode)

tvsirius commented 10 months ago

Good, just fix the other issues

MIT-Emerging-Talent / 2024-group-02-collaboration-practice