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.

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

Add doctests for graphs_floyd_warshall.py #12436

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

asmitannu
Copy link

@asmitannu asmitannu commented Dec 15, 2024

Describe your change:

Contributes to #9943

Added Doc tests
Added algorithm
Added type hints
Modified the function to return result

  • 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 Dec 15, 2024
@algorithms-keeper algorithms-keeper bot added tests are failing Do not merge until tests pass and removed tests are failing Do not merge until tests pass labels Dec 15, 2024
@algorithms-keeper algorithms-keeper bot added tests are failing Do not merge until tests pass and removed tests are failing Do not merge until tests pass labels Dec 15, 2024
@asmitannu
Copy link
Author

Added doc tests, contributes to resolving the issue #9943

@asmitannu
Copy link
Author

@poyea Hi. I just added some tests to improve the coverage. Could you check it pls? Thank you

@asmitannu
Copy link
Author

@cclauss Hi. I added some tests to improve the coverage. Could you please check it? Thank you.

@algorithms-keeper algorithms-keeper bot added tests are failing Do not merge until tests pass and removed tests are failing Do not merge until tests pass labels Dec 19, 2024
@tianyizheng02 tianyizheng02 mentioned this pull request Dec 30, 2024
15 tasks
Comment on lines +9 to +16
# 1. For all edges from v to n, distance[i][j] = weight(edge(i, j)).

# 2. distance[i][j] = min(distance[i][j], distance[i][k] + distance[k][j]).

# 3. Step 2 is true for each pair of vertices.Repeat for k vertex in the graph.

# 4. Whenever distance[i][j] is given a new minimum value,
# next vertex[i][j] = next vertex[i][k].
Copy link
Contributor

Choose a reason for hiding this comment

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

This algorithm explanation should be moved into the docstring at the top of the file


_print_dist(dist, v)
return dist, v
return dist, vertex
Copy link
Contributor

Choose a reason for hiding this comment

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

Is vertex just the input parameter vertex? If this variable isn't being modified in the function, then there's no need to return it again because we already know what the value is.

@@ -1,62 +1,112 @@
# floyd_warshall.py
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# floyd_warshall.py

I'm not sure why this comment is here

@tianyizheng02 tianyizheng02 added awaiting changes A maintainer has requested changes to this PR and removed awaiting reviews This PR is ready to be reviewed labels Dec 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting changes A maintainer has requested changes to this PR enhancement This PR modified some existing files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants