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

Enhance traversal docs #1375

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

barakatzir
Copy link

This PR fixes #1361.
It add some elaboration to the traversal BFS and DFS functions, mainly with a more concrete pseudo-code.
I also fixed small doc errors in betweenness function's docstrings.
In the issue I also suggested doing a face-lift to the dijkstra_search. I can add this in to this PR in the style of the other docstrings changes I'm proposing If you'd like.

  • [v] I ran the nox -e docs and cargo doc to see that the result is good.
  • [v] I have read the CONTRIBUTING document.

@CLAassistant
Copy link

CLAassistant commented Jan 29, 2025

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@IvanIsCoding
Copy link
Collaborator

Thanks for submitting this! I will try to review it when I can, but again this is a welcome contribution.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 13047597904

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 95.819%

Totals Coverage Status
Change from base Build 13020512734: 0.0%
Covered Lines: 18381
Relevant Lines: 19183

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

python BFS and DFS search documentation improvements
4 participants