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

Increase code coverage for dijkstra algorithm #10695

Merged
merged 7 commits into from
Oct 27, 2023
Merged

Increase code coverage for dijkstra algorithm #10695

merged 7 commits into from
Oct 27, 2023

Conversation

R055A
Copy link
Contributor

@R055A R055A commented Oct 19, 2023 •
edited
Loading

Describe your change:

Ref #9943

Add doctests to dijkstra_algorithm.py to improve code coverage
Bug fixed where required to execute and pass doctests
Moved method declaration comments to doc strings for methods doc strings are added to for the doctests

Code coverage improved from 16% to 85% (or 100% when not including the main block)

  • 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 the awaiting reviews This PR is ready to be reviewed label Oct 19, 2023
@R055A R055A mentioned this pull request Oct 19, 2023
Open
@cclauss
Copy link
Member

cclauss commented Oct 19, 2023

In the commit message above, what does the second checked bullet say?

@R055A
Copy link
Contributor Author

R055A commented Oct 19, 2023

In the commit message above, what does the second checked bullet say?

Thank you @cclauss for the feedback. Are you referring to the PR comment? I may have misinterpreted. I made changes to some variable names for readability. I have removed the tick.

cclauss
cclauss requested changes Oct 19, 2023
View reviewed changes
Copy link
Member

@cclauss cclauss left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Please open a new pull request and copy in ONLY the doctests from this pull request. Once that new pull request is merged, we can come back to the code changes in this pull request.

@algorithms-keeper algorithms-keeper bot added awaiting changes A maintainer has requested changes to this PR and removed awaiting reviews This PR is ready to be reviewed labels Oct 19, 2023
@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed and removed awaiting changes A maintainer has requested changes to this PR labels Oct 21, 2023
@R055A R055A requested a review from cclauss October 21, 2023 10:00
@R055A
Copy link
Contributor Author

R055A commented Oct 21, 2023

Please open a new pull request and copy in ONLY the doctests from this pull request. Once that new pull request is merged, we can come back to the code changes in this pull request.

Hi @cclauss I have removed code changes in this PR so that only doctests remain with exception for a bug fix in the min_heapify method. Considering method doc strings are used for the doctests, I have also moved method description comments into these.

@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 21, 2023
@R055A
Copy link
Contributor Author

R055A commented Oct 27, 2023

Hi @cclauss is there any possibility of this PR being merged soon as I would prefer it to be so before continuing with code changes in a new PR

cclauss
cclauss approved these changes Oct 27, 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.

Please make PriorityQueue a https://docs.python.org/3/library/dataclasses.html

@cclauss cclauss merged commit b0837d3 into TheAlgorithms:master Oct 27, 2023
sedatguzelsemme pushed a commit to sedatguzelsemme/Python that referenced this pull request Sep 15, 2024
@R055A @cclauss
@pre-commit-ci @sedatguzelsemme
Increase code coverage for dijkstra algorithm (TheAlgorithms#10695)
f56f831 
* Increase code coverage for dijkstra algorithm

* Add missing code coverage

Refactor to pass mypy

* Fix missing code coverage

* Remove code changes, keep doctest

* Remove ALL of the code changes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update dijkstra_algorithm.py

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@isidroas isidroas mentioned this pull request Jan 25, 2025
Closed
14 tasks
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
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@R055A @cclauss