Skip to content

Insertion sort : type hint, docstring #2327

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

Merged
merged 6 commits into from
Aug 23, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions sorts/insertion_sort.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
"""
This is a pure Python implementation of the insertion sort algorithm
A pure Python implementation of the insertion sort algorithm

This algorithm sorts a collection by comparing adjacent elements.
When it finds that order is not respected, it moves the element compared
backward until the order is correct. It then goes back directly to the
element's initial position resuming forward comparison.

For doctests run following command:
python -m doctest -v insertion_sort.py
or
python3 -m doctest -v insertion_sort.py

For manual testing run:
python insertion_sort.py
python3 insertion_sort.py
"""


def insertion_sort(collection):
"""Pure implementation of the insertion sort algorithm in Python
def insertion_sort(collection: list) -> list:
"""A pure Python implementation of the insertion sort algorithm

:param collection: some mutable ordered collection with heterogeneous
comparable items inside
Expand Down Expand Up @@ -47,4 +50,4 @@ def insertion_sort(collection):
if __name__ == "__main__":
user_input = input("Enter numbers separated by a comma:\n").strip()
unsorted = [int(item) for item in user_input.split(",")]
print(insertion_sort(unsorted))
print(f"{insertion_sort(unsorted) = }")