chore: Add template for algorithms documentation#834
Merged
Conversation
starovoid
added
the
A-readme
Member
|
Looks great, thanks 🌞 |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
ABorgna
reviewed
Jun 21, 2025
ABorgna
approved these changes
Jun 21, 2025
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jun 21, 2025
This PR removes the \[Generic\] tag from the docstrings of algorithms as discussed [here](#834 (comment)).
Co-authored-by: Agustín Borgna <[email protected]>
RaoulLuque
force-pushed
the
algodocs-deflts
branch
from
9ec4388 to
53e447e
Compare
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Member
|
Not sure what's going on with the rust stable job but I'm re-running it 🤔 |
Collaborator
Author
I recently had a nightly test fail, so there must be a system-related reason. |
Member
|
system-related as in GitHub CI runners or something in the crate that is flaky? |
Member
|
I would merge this PR anyway, right? Since adding this markdown file should certainly not be the issue, right? 🤔 |
Collaborator
Author
Maybe something changed in the testing env, and now the quickcheck test for the SPFA algorithm is failing. We need to change this test by not calling |
RaoulLuque
added a commit
to RaoulLuque/petgraph
that referenced
this pull request
Sep 21, 2025
This PR removes the \[Generic\] tag from the docstrings of algorithms as discussed [here](petgraph#834 (comment)).
RaoulLuque
pushed a commit
to RaoulLuque/petgraph
that referenced
this pull request
Sep 21, 2025
This PR adds a file describing the approach to documenting algorithms. In the future, this file will be referenced by `CONTRIBUTING.md` and any other instructions for adding new algorithms. --------- Co-authored-by: Agustín Borgna <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a file describing the approach to documenting algorithms.
In the future, this file will be referenced by
CONTRIBUTING.mdand any other instructions for adding new algorithms.