xgi-org / xgi

CompleX Group Interactions (XGI) is a Python package for higher-order networks.
https://xgi.readthedocs.io
Other
182 stars 30 forks source link

`to_bipartite_graph` documented return type is incorrect #322

Closed jg-you closed 1 year ago

jg-you commented 1 year ago

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 commented 1 year ago

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

maximelucas commented 1 year ago

Thanks @jg-you !

leotrs commented 1 year ago

@jg-you fixed.

jg-you commented 1 year ago

That was fast!