Skip to content
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.

Sign up for GitHub

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

Jump to bottom

to_bipartite_graph documented return type is incorrect #322

Closed
jg-you opened this issue Apr 4, 2023 · 4 comments · Fixed by #323
Closed

to_bipartite_graph documented return type is incorrect #322

jg-you opened this issue Apr 4, 2023 · 4 comments · Fixed by #323

Comments

@jg-you
Copy link

jg-you commented Apr 4, 2023

The docstring for xgi.to_bipartite_graph states that the function returns a bipartite graph directly:
https://xgi.readthedocs.io/en/stable/api/convert.html?highlight=to_bipartite_graph#xgi.convert.to_bipartite_graph

But the function returns a triplet of a graph with two mappings, I think from integers to node / edges IDs?
https://xgi.readthedocs.io/en/stable/_modules/xgi/convert.html#to_bipartite_graph
@leotrs leotrs mentioned this issue Apr 5, 2023
Merged
@leotrs
Copy link
Collaborator

leotrs commented Apr 5, 2023

Thanks @jg-you, this should be fixed shortly (#323)

@maximelucas
Copy link
Collaborator

Thanks @jg-you !

leotrs added a commit that referenced this issue Apr 5, 2023
@leotrs
Index-to-unit mappings from to_bipartite_graph. Fixes #322 (#323)
ca4fb51 
Optionally return the index-to-unit mappings from to_bipartite_graph. The default has been set to False to mirror the behavior of linalg. Fixes 322.
@leotrs
Copy link
Collaborator

leotrs commented Apr 5, 2023

@jg-you fixed.

@jg-you
Copy link
Author

jg-you commented Apr 5, 2023

That was fast!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Index-to-unit mappings from to_bipartite_graph. Fixes #322 xgi-org/xgi
3 participants
@leotrs @jg-you @maximelucas