Skip to content

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

rahaman-quantum
Copy link

@rahaman-quantum rahaman-quantum commented May 8, 2025

Closes the issue: #1410
Added the required documentation.

@CLAassistant
Copy link

CLAassistant commented May 8, 2025

CLA assistant check
All committers have signed the CLA.

Copy link
Member

@mtreinish mtreinish left a 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
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// Data with labels for nodes
/// Data with labels for nodes::

@mtreinish
Copy link
Member

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.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 14929213682

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 95.236%

Totals Coverage Status
Change from base Build 14916993103: 0.0%
Covered Lines: 18730
Relevant Lines: 19667

💛 - Coveralls

Copy link
Member

@mtreinish mtreinish left a 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.

Comment on lines +1373 to +1374
/// For example for csv based data, you may use the below code::
///
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// 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::
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// For Labels Based Data::
/// For Labels Based Data:
///
/// .. jupyter-execute::
///

Comment on lines +1375 to +1380
/// import rustworkx as rx
/// from rustworkx.visualization import mpl_draw
///
/// file="/tmp/123.txt"
///
/// with open(file,"w+") as fd:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// 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:

Comment on lines +1394 to +1399
/// import rustworkx as rx
/// from rustworkx.visualization import mpl_draw
///
/// file="/tmp/123.txt"
///
/// with open(file,"w+") as fd:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// 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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants