Skip to content

Commit 26146af

Browse files
committed
Docs: Fixed release notes with the latest changes
1 parent df5b3b5 commit 26146af

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

releasenotes/notes/add-cycle-basis-edges-5cb31eac7e41096d.yaml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
features:
33
- |
4-
The function :func:`~rustworkx.cycle_basis` from the crate ``rustworkx-core``
5-
in the ``connectivity`` module was modified. This function now has the option
6-
of returning the edge indices that form the cycle basis of a graph.
4+
A function, :func:`~rustworkx.cycle_basis_edges` was added to the crate
5+
``rustworkx-core`` in the ``connectivity`` module. This function returns
6+
the edge indices that form the cycle basis of a graph.
77
88
.. jupyter-execute::
99
@@ -43,14 +43,13 @@ features:
4343
4444
mpl_draw(graph, with_labels=True)
4545
# Retrieve EdgeIDs by enabling the edges flag.
46-
cycles_edges = rustworkx.cycle_basis(graph, a, edges=True)
46+
cycles_edges = rustworkx.cycle_basis_edges(graph, a)
4747
edge_list = list(graph.edge_list())
4848
cycle_info = [[edge_list[edge] for edge in cycle] for cycle in cycles_edges]
4949
# Print the EdgeID's that form cycles in the graph
5050
display(cycles_edges)
5151
# Print the data retrieved from the graph.
5252
display(cycle_info)
53-
5453
fixes:
5554
- |
5655
Support for edges when getting the cycle basis. Refer to

0 commit comments

Comments
 (0)