Skip to content
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

Added doctest to heap.py #11129

Merged
merged 2 commits into from
Nov 13, 2023
Merged

Added doctest to heap.py #11129

merged 2 commits into from
Nov 13, 2023

Conversation

Suyashd999
Copy link
Contributor

Describe your change:

Contributes to #9943

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • 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 include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels Oct 31, 2023
@cclauss cclauss added ON HOLD: Final hours of Hacktoberfest We will review this PR after Hacktoberfest has ended and removed ON HOLD: Final hours of Hacktoberfest We will review this PR after Hacktoberfest has ended labels Oct 31, 2023
@algorithms-keeper algorithms-keeper bot mentioned this pull request Nov 3, 2023
Closed
15 tasks
@Suyashd999
Copy link
Contributor Author

Hey @cclauss , @tianyizheng02 can you please review this PR I am unable to make more contributions as I have reached the limit of 5 open PR

cclauss
cclauss reviewed Nov 5, 2023
View reviewed changes
data_structures/heap/heap.py
return the parent index of given child

>>> h = Heap()
>>> h.build_max_heap([103, 9, 1, 7, 11, 15, 25, 201, 209, 107, 5])
Copy link
Member

@cclauss cclauss Nov 5, 2023 •
edited

Choose a reason for hiding this comment

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

Let's test with zero, negative integers, floating point numbers, and strings.

Let's test h.parent_index(12) which is NOT in the heap.

We want to test how the algorithm works but also how it fails when given bad input.

@cclauss cclauss added the awaiting changes A maintainer has requested changes to this PR label Nov 5, 2023
@Suyashd999
Copy link
Contributor Author

@cclauss done with the changes

@algorithms-keeper algorithms-keeper bot mentioned this pull request Nov 6, 2023
Closed
15 tasks
@Suyashd999
Copy link
Contributor Author

hey @cclauss can you review this please. Thanks!

cclauss
cclauss approved these changes Nov 13, 2023
View reviewed changes
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

These tests prove that parent heap is buggy. It returns None when it should be raising a ValueError and it returns float when its type hints promised that it would only return int | None. These bugs should be fixed in a future pull request.

@cclauss cclauss merged commit 0e2e6ab into TheAlgorithms:master Nov 13, 2023
3 checks passed
cclauss pushed a commit to cclauss/Python that referenced this pull request Jan 13, 2024
@Suyashd999 @cclauss
Added doctest to heap.py (TheAlgorithms#11129)
43bb952 
* Added doctest to heap.py

* Update heap.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss cclauss approved these changes

Assignees
No one assigned
Labels
awaiting changes A maintainer has requested changes to this PR awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@Suyashd999 @cclauss