Skip to content

Add type hints and docstrings to heap.py - #3013

Merged
dhruvmanila merged 8 commits into
TheAlgorithms:masterfrom
MarkHershey:patch-1
Dec 26, 2020
Merged

Add type hints and docstrings to heap.py#3013
dhruvmanila merged 8 commits into
TheAlgorithms:masterfrom
MarkHershey:patch-1

Conversation

@MarkHershey

@MarkHersheyMarkHershey commented Oct 7, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

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
Add type hints and docstrings to heap.py
9e370be
- Add type hints
- Add docstrings
- Add explanatory comments - Improve code readability
- Change to use f-string
@MarkHershey
Fix import sorting
6b3d70d
@MarkHershey

MarkHershey commented Oct 13, 2020

Copy link
Copy Markdown
ContributorAuthor

#2510

@stale

staleBot commented Nov 21, 2020

Copy link
Copy Markdown

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stalestaleBot added the stale Used to mark an issue or pull request stale. label Nov 21, 2020
@MarkHershey

MarkHershey commented Nov 22, 2020

Copy link
Copy Markdown
ContributorAuthor

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

This PR still pending approval.

@stalestaleBot removed the stale Used to mark an issue or pull request stale. label Nov 22, 2020
@ghostghost added the awaiting reviews This PR is ready to be reviewed label Nov 22, 2020
@dhruvmanila
dhruvmanila self-requested a review November 22, 2020 10:27
@dhruvmanila

dhruvmanila commented Nov 23, 2020

Copy link
Copy Markdown
Member

Please run mypy on this file on your local machine and check if there are any errors.

python -m pip install mypy
mypy --ignore-missing-imports path/to/heap.py

@ghostghost added require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html tests are failing Do not merge until tests pass and removed awaiting reviews This PR is ready to be reviewed labels Nov 23, 2020
@stale

staleBot commented Dec 24, 2020

Copy link
Copy Markdown

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stalestaleBot added the stale Used to mark an issue or pull request stale. label Dec 24, 2020
@stalestaleBot removed the stale Used to mark an issue or pull request stale. label Dec 24, 2020
@ghostghost added awaiting reviews This PR is ready to be reviewed and removed require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html tests are failing Do not merge until tests pass labels Dec 24, 2020
@MarkHershey

MarkHershey commented Dec 24, 2020

Copy link
Copy Markdown
ContributorAuthor

Please run mypy on this file on your local machine and check if there are any errors.

python -m pip install mypy
mypy --ignore-missing-imports path/to/heap.py

Done checking, no error.

dhruvmanila
dhruvmanila requested changes Dec 25, 2020
View reviewed changes

@dhruvmaniladhruvmanila left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is looking good! 👍
Please import the type: from typing import Optional

Comment threaddata_structures/heap/heap.py Outdated
Comment threaddata_structures/heap/heap.py Outdated
Comment threaddata_structures/heap/heap.py Outdated
Comment threaddata_structures/heap/heap.py Outdated
Comment threaddata_structures/heap/heap.py Outdated
Comment threaddata_structures/heap/heap.py Outdated
Comment threaddata_structures/heap/heap.py Outdated
Comment threaddata_structures/heap/heap.py Outdated
Comment threaddata_structures/heap/heap.py Outdated
Comment threaddata_structures/heap/heap.py Outdated
@ghostghost added awaiting changes A maintainer has requested changes to this PR and removed awaiting reviews This PR is ready to be reviewed labels Dec 25, 2020
@ghostghost added awaiting reviews This PR is ready to be reviewed and removed awaiting changes A maintainer has requested changes to this PR labels Dec 25, 2020
dhruvmanila
dhruvmanila approved these changes Dec 26, 2020
View reviewed changes

@dhruvmaniladhruvmanila left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Awesome work! Thanks for your persistence! LGTM! 🎉

@ghostghost removed the awaiting reviews This PR is ready to be reviewed label Dec 26, 2020
@dhruvmanila
dhruvmanila merged commit 207ac95 into TheAlgorithms:masterDec 26, 2020
stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
@MarkHersheygithub-actions
@dhruvmanila@stokhos
[mypy] Add type hints and docstrings to heap.py (TheAlgorithms#3013)
d22cb26
* Add type hints and docstrings to heap.py
- Add type hints
- Add docstrings
- Add explanatory comments - Improve code readability
- Change to use f-string
* Fix import sorting
* fixup! Format Python code with psf/black push
* Fix static type error
* Fix failing test
* Fix type hints
* Add return annotation
Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
peRFectBeliever pushed a commit to peRFectBeliever/Python that referenced this pull request Apr 1, 2021
@MarkHersheygithub-actions
@dhruvmanila@peRFectBeliever
[mypy] Add type hints and docstrings to heap.py (TheAlgorithms#3013)
a1833ad
* Add type hints and docstrings to heap.py
- Add type hints
- Add docstrings
- Add explanatory comments - Improve code readability
- Change to use f-string
* Fix import sorting
* fixup! Format Python code with psf/black push
* Fix static type error
* Fix failing test
* Fix type hints
* Add return annotation
Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
Panquesito7 pushed a commit to Panquesito7/Python that referenced this pull request May 13, 2021
@MarkHersheygithub-actions@dhruvmanila
[mypy] Add type hints and docstrings to heap.py (TheAlgorithms#3013)
c4b4591
* Add type hints and docstrings to heap.py
- Add type hints
- Add docstrings
- Add explanatory comments - Improve code readability
- Change to use f-string
* Fix import sorting
* fixup! Format Python code with psf/black push
* Fix static type error
* Fix failing test
* Fix type hints
* Add return annotation
Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
shermanhui pushed a commit to shermanhui/Python that referenced this pull request Oct 22, 2021
@MarkHersheygithub-actions
@dhruvmanila@shermanhui
[mypy] Add type hints and docstrings to heap.py (TheAlgorithms#3013)
d1132c4
* Add type hints and docstrings to heap.py
- Add type hints
- Add docstrings
- Add explanatory comments - Improve code readability
- Change to use f-string
* Fix import sorting
* fixup! Format Python code with psf/black push
* Fix static type error
* Fix failing test
* Fix type hints
* Add return annotation
Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dhruvmaniladhruvmaniladhruvmanila approved these changes
+1 more reviewer
@kbakdevkbakdevkbakdev approved these changes
Reviewers whose approvals may not affect merge requirements

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

@MarkHershey@dhruvmanila@kbakdev