-
Notifications
You must be signed in to change notification settings - Fork 179
Read edge list doc #1444
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
base: main
Are you sure you want to change the base?
Read edge list doc #1444
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this, can you sign the cla per the bot comment which is a requirement before we can accept the pull request. I also left some commetns inline
src/graph.rs
Outdated
/// | ||
/// graph = rx.PyGraph.read_edge_list(path=file, deliminator=",") | ||
/// | ||
/// Data with labels for nodes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// Data with labels for nodes | |
/// Data with labels for nodes:: |
Actually looking at the comment from the bot, the issue is the author email from the first two commits on your PR's branch aren't associated with your github account. You can either add that email to your github account or reset the the author field in those commits and force push an update to this branch. |
Pull Request Test Coverage Report for Build 14929213682Details
💛 - Coveralls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With the drawing you've got in place there now it would be better to just use jupyter-execute
to generate a visualization from the code example during the docs build. I left some inline suggestions on how to do this. But I will say that github's web ui editor makes dealing with whitespace very difficult, so my inline suggestion might not be exactly correct. You might be better off making the change locally and not applying the suggestion directly.
/// For example for csv based data, you may use the below code:: | ||
/// |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// For example for csv based data, you may use the below code:: | |
/// | |
/// For example for csv based data, you may use the below code: | |
/// | |
/// .. jupyter-execute:: | |
/// |
/// mpl_draw(graph) | ||
/// | ||
/// | ||
/// For Labels Based Data:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// For Labels Based Data:: | |
/// For Labels Based Data: | |
/// | |
/// .. jupyter-execute:: | |
/// |
/// import rustworkx as rx | ||
/// from rustworkx.visualization import mpl_draw | ||
/// | ||
/// file="/tmp/123.txt" | ||
/// | ||
/// with open(file,"w+") as fd: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// import rustworkx as rx | |
/// from rustworkx.visualization import mpl_draw | |
/// | |
/// file="/tmp/123.txt" | |
/// | |
/// with open(file,"w+") as fd: | |
/// import tempfile | |
/// | |
/// import rustworkx as rx | |
/// from rustworkx.visualization import mpl_draw | |
/// | |
/// with tempfile.NamedTemporaryFile('wt') as fd: |
/// import rustworkx as rx | ||
/// from rustworkx.visualization import mpl_draw | ||
/// | ||
/// file="/tmp/123.txt" | ||
/// | ||
/// with open(file,"w+") as fd: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// import rustworkx as rx | |
/// from rustworkx.visualization import mpl_draw | |
/// | |
/// file="/tmp/123.txt" | |
/// | |
/// with open(file,"w+") as fd: | |
/// import tempfile | |
/// | |
/// import rustworkx as rx | |
/// from rustworkx.visualization import mpl_draw | |
/// | |
/// with tempfile.NamedTemporaryFile('wt') as fd: |
Closes the issue: #1410
Added the required documentation.