Prepare 0.15.1 release (#1231)

* Prepare 0.15.1 release

This commit prepares for a 0.15.1 release to fix an inadvertant breaking
api change in graphviz_draw() that is causing issues for existing users
of the visualizer.

* Release note fixes

* Fix typos in 0.15.0 release notes

This commit fixes typos in the 0.15.0 release notes that were missed
during that release. While technically unrelated to preparing 0.15.1
this is a good opportunity to fix them since we'll be rebuilding the
docs as part of the new release.

* Fix spelling in prelude

* Apply suggestions from code review

Co-authored-by: Jake Lishman <jake@binhbar.com>

* Move new release notes

---------

Co-authored-by: Jake Lishman <jake@binhbar.com>

Author: mtreinish

Cargo.lock

@@ -16,7 +16,7 @@ members = [
 ]
 
 [workspace.package]
-version = "0.15.0"
+version = "0.15.1"
 edition = "2021"
 rust-version = "1.70"
 authors = ["Matthew Treinish <mtreinish@kortar.org>"]
@@ -59,7 +59,7 @@ rayon.workspace = true
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 smallvec = { version = "1.0", features = ["union"] }
-rustworkx-core = { path = "rustworkx-core", version = "=0.15.0" }
+rustworkx-core = { path = "rustworkx-core", version = "=0.15.1" }
 
 [dependencies.pyo3]
 version = "0.21.2"

Cargo.toml

@@ -26,7 +26,7 @@
 # The short X.Y version.
 version = '0.15'
 # The full version, including alpha/beta/rc tags.
-release = '0.15.0'
+release = '0.15.1'
 
 extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.autosummary',

docs/source/conf.py

@@ -1,11 +1,13 @@
 ---
 features:
   - |
-    Added a function ``~rustworkx_core.dag_algo::layers`` in rustworkx-core to 
-    get the layers of a directed acyclic graph.  This is equivalent to the
+    Added a new function ``rustworkx_core::dag_algo::layers`` to rustworkx-core
+    to get the layers of a directed acyclic graph.  This is equivalent to the
     :func:`.layers` function that existed in the Python API but now exposes it
     for Rust users too.
 fix:
   - |
-    When calling ``~rustworkx_core.dag_algo::layers``if the provided graph has
-    a cycle, the function will throw a ``DAGHasCycle`` error instance.
+    When calling :func:`~.layers` with a graph containing a cycle, the
+    function will throw a ``DAGHasCycle`` error instance now. Previously, the
+    function would get stuck in an infinite loop if a graph with a cycle was
+    passed to the function.

releasenotes/notes/0.15/add-layers-rustworkx-core-1caaccb1ca292ca8.yaml

@@ -4,19 +4,19 @@ fixes:
     Fixed an issue in the :func:`~.graphviz_draw`, :meth:`.PyGraph.to_dot`, and
     :meth:`.PyDiGraph.to_dot` which was incorrectly escaping strings when
     upgrading to 0.15.0. In earlier versions of rustworkx if you manually
-    placed quotes in a string for an attr callback get that to pass through to 
-    the output dot file this was incorrectly being converted in rustworkx 0.15.0
-    to duplicate the quotes and escape them. For example, if you defined a
-    callback like::
+    placed quotes in a string for an attr callback to get that to pass through
+    to the output dot file, this was incorrectly being converted in rustworkx
+    0.15.0 to duplicate the quotes and escape them. For example, if you defined
+    a callback like::
 
         def color_node(_node):
             return {
                 "color": '"#422952"'
             }
 
     to set the color attribute in the output dot file with the string
-    `"#422952"` (with the quotes) this was incorrectly being converted to
-    `\"#422952\"`. This no longer occurs, in rustworkx 0.16.0 there will likely
-    be additional options exposed in :func:`~.graphviz_draw`,
+    ``"#422952"`` (with the quotes), this was incorrectly being converted to
+    ``"\"#422952\""``. This no longer occurs, in rustworkx 0.16.0 there will
+    likely be additional options exposed in :func:`~.graphviz_draw`,
     :meth:`.PyGraph.to_dot`, and :meth:`.PyDiGraph.to_dot` to expose further
     options around this.

…-graphviz-escaping-39a2d1cebb586eca.yaml …-graphviz-escaping-39a2d1cebb586eca.yamlreleasenotes/notes/fix-graphviz-escaping-39a2d1cebb586eca.yaml renamed to releasenotes/notes/0.15/fix-graphviz-escaping-39a2d1cebb586eca.yaml releasenotes/notes/fix-graphviz-escaping-39a2d1cebb586eca.yaml renamed to releasenotes/notes/0.15/fix-graphviz-escaping-39a2d1cebb586eca.yaml

@@ -0,0 +1,4 @@
+---
+prelude: >
+  This release is a bugfix patch release that fixes an inadvertent breaking
+  API change for the :func:`.graphviz_draw` function in the 0.15.0 release.