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

docs: add documentation for BFS (#56) #73

Merged
merged 3 commits into from
Aug 15, 2023

Conversation

MichaeINeumann
Copy link
Contributor

Hello, I made the documentation for BFS.
Please Check the ## Syntax section. I understood not exactly what I did here.
Also I'm not sure with the content at ### BFS is particularly useful for: , because I not used this algorithms in praxis.
I have only experience with dijkstra in robot programming.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hi there! Thank you for creating your first pull-request on the Graaf library :)

@codecov
Copy link

codecov bot commented Aug 13, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.07% ⚠️

Comparison is base (0844d8b) 99.73% compared to head (3c4b0f7) 99.67%.
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #73      +/-   ##
==========================================
- Coverage   99.73%   99.67%   -0.07%     
==========================================
  Files          23       23              
  Lines        1140     1226      +86     
==========================================
+ Hits         1137     1222      +85     
- Misses          3        4       +1     

see 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bobluppes
Copy link
Owner

Thanks for your contribution 🚀
It looks very detailed, I will take a closer look tomorrow. Tagging #56

Copy link
Owner

@bobluppes bobluppes left a comment

Choose a reason for hiding this comment

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

Hi @MichaeINeumann thank you for the contribution! The section looks very detailed and provides very good examples of BFS use cases.

Only one comment on the Syntax section, let me know what you think and we can merge it 🚀

docs/docs/algorithms/traversal/breadth-first-search.md Outdated Show resolved Hide resolved
MichaeINeumann and others added 2 commits August 15, 2023 16:55
Co-authored-by: Bob Luppes <bobluppes@gmail.com>
a/b/c was displayed in one line
@bobluppes
Copy link
Owner

Thanks, LGTM 👍🏻

@bobluppes bobluppes added the documentation Improvements or additions to documentation label Aug 15, 2023
@bobluppes bobluppes merged commit 3933598 into bobluppes:main Aug 15, 2023
8 checks passed
@MichaeINeumann MichaeINeumann deleted the doc_(BFS) branch August 17, 2023 15:19
@Hromz Hromz mentioned this pull request Aug 18, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants