Add type annotation docs for PyGraph - #1685
Open
Krishnendu Rajesh (krishnendurajesh) wants to merge 4 commits into
Open
Krishnendu Rajesh (krishnendurajesh) wants to merge 4 commits into
Krishnendu Rajesh (krishnendurajesh) wants to merge 4 commits into
Conversation
|
|
Coverage Report for CI Build 36174931069Coverage remained the same at 94.692%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
Contributor
|
I'd also suggest at least a small example be added to the Usage section of the README to make it more discoverable for new users |
Added section on type annotations for PyGraph parameters and usage examples.
Author
|
Done! Added an example to the Usage section in the README. Hope it works |
Ivan Carvalho (IvanIsCoding)
left a comment
Ivan Carvalho (IvanIsCoding)
left a comment
Collaborator
There was a problem hiding this comment.
I haven’t had much time to review PRs for rustworkx for the last couple weeks but I left some comments. Thanks for starting the contribution.
Removed outdated examples and added note on type annotations.
Added type annotation examples for PyDiGraph parameters.
This branch has not been deployed
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
5 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.
Fixes #1558
Adds "Type Annotations" section to "PyGraph" docstring such that it explains:
1.order of parameters ;
PyGraph[NodeData, EdgeData]2.Requirement of adding
| Nonefor edge type annotation while usingadd_edges_from_no_datamethod