Skip to content

Commit 70541c8

Browse files
committed
Docs: Add upgrade release note
1 parent f3f271a commit 70541c8

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

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

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
---
22
features:
33
- |
4-
A function, :func:`~rustworkx.cycle_basis_edges` was added to the crate
4+
A function, ``cycle_basis_edges`` was added to the crate
55
``rustworkx-core`` in the ``connectivity`` module. This function returns
66
the edge indices that form the cycle basis of a graph.
7+
- |
8+
Added a new function :func:`~rustworkx.cycle_basis_edges` which is similar
9+
to the existing :func:`~.cycle_basis` function but instead of returning node
10+
indices it returns a list of edge indices for the cycle.
711
812
.. jupyter-execute::
913
@@ -50,6 +54,11 @@ features:
5054
display(cycles_edges)
5155
# Print the data retrieved from the graph.
5256
display(cycle_info)
57+
upgrade:
58+
- |
59+
The trait bounds of :func:`rustworkx_core::connectivity::cycle_basis` now
60+
requires graphs to be compatible with the trait ``IntoEdges`` and that the
61+
attribute ``EdgeId`` conforms to `Eq` and `Hash`.
5362
fixes:
5463
- |
5564
Support for edges when getting the cycle basis. Refer to

0 commit comments

Comments
 (0)