The Wayback Machine - https://web.archive.org/web/20201019103955/https://github.com/TheAlgorithms/Python/pull/3013
Skip to content

/ Python

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

Jump to bottom

Add type hints and docstrings to heap.py #3013

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

Add type hints and docstrings to heap.py #3013

wants to merge 2 commits into from
+101 −78

Conversation

@MarkHershey
Copy link

@MarkHershey MarkHershey commented Oct 7, 2020 •
edited

Changes:

  • Add type hints
  • Add docstrings
  • Add explanatory comments
  • Improve code readability
  • Change to use f-string
  • 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}.
MarkHershey added 2 commits Oct 7, 2020
@MarkHershey
Add type hints and docstrings to heap.py
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
9e370be 
- Add type hints
- Add docstrings
- Add explanatory comments 
- Improve code readability
- Change to use f-string
@MarkHershey
Fix import sorting
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
6b3d70d
@MarkHershey
Copy link
Author

@MarkHershey MarkHershey commented Oct 13, 2020

#2510
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
1 participant
@MarkHershey
You can’t perform that action at this time.