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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Aug 23, 2020
Merged

Insertion sort : type hint, docstring #2327

merged 6 commits into from
Aug 23, 2020

Conversation

grochedix
Copy link
Contributor

Describe your change:

Insertion sort : module docstring + type hint.

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

@grochedix grochedix changed the title Insertion sort Insertion sort : type hint, docstring Aug 17, 2020
Bennyhwanggggg
Bennyhwanggggg suggested changes Aug 22, 2020
View reviewed changes
sorts/insertion_sort.py Outdated
Comment on lines 4 to 8
This algorithm sorts a collection by comparing adjacent elements.
When it finds that order is not respected, it moves the element compared
backward until order is right.
It then goes back directly to element initial position resuming forward comparison.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be "it moves the element by comparing backward until the order is right and insert it there. It then goes back to the element's initial position and resumes forward comparison."

Otherwise, the English sounds weird here.

@cclauss cclauss merged commit ee28dee into TheAlgorithms:master Aug 23, 2020
stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
@grochedix @cclauss @stokhos
Insertion sort : type hint, docstring (TheAlgorithms#2327)
f05530e 
* insertion sort : docstring, type hinting

* Update insertion_sort.py

Co-authored-by: Christian Clauss <cclauss@me.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Bennyhwanggggg Bennyhwanggggg Bennyhwanggggg requested changes

@cclauss cclauss cclauss approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@grochedix @cclauss @Bennyhwanggggg