Enhance docs in toposort #1409
Merged
Enhance docs in toposort #1409
Conversation
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
Pull Request Test Coverage Report for Build 14178685124Details
💛 - Coveralls |
IvanIsCoding
approved these changes
Apr 1, 2025
There was a problem hiding this comment.
With regards to jupyter-execute. For code that has plots (i.e. generators, graph layouts) we always want to use the Jupyter option to generate visual output for the user.
For code that needs to run but outputs text, it is 50/50. I talked with Matthew, too many would slow down our documentation. But right now we have too few.
So in general if the method is non-trivial and the outptu is useful, jupyter-execute. But either is fine, I appreciate just the plain markdown in places where we used to have no documentation
SILIZ4
pushed a commit
to SILIZ4/rustworkx
that referenced
this pull request
Jul 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Format cross-references and make the example code more explicit.
BTW, do you prefer using jupyter-execute or
>>>-indented docstring-like code?