release: 0.83.2

Changed

- Add images to `bfs_pred` documentation.
- Improve documentation images.

CHANGELOG.md

@@ -27,12 +27,19 @@
 - Test multi-source DFS.
 - Move goals to `GOALS.md`.
 
+## [0.83.2] - 2024-08-25
+
+Changed
+
+- Add images to `bfs_pred` documentation.
+- Improve documentation images.
+
 ## [0.83.1] - 2024-08-24
 
 Changed
 
 - Add images to `bfs_dist` documentation.
-- Improve documentation example image consistency.
+- Improve documentation image consistency.
 - Split `README.md` into `README.md`, `GOALS.md`, and `NAMING.md`.
 
 ## [0.83.0] - 2024-08-23

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "graaf"
-version = "0.83.1"
+version = "0.83.2"
 edition = "2021"
 authors = ["Bas Dirks <bas.dirks@protonmail.com>"]
 categories = ["algorithms", "data-structures", "mathematics"]

README.md

@@ -28,7 +28,7 @@ Add the following to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-graaf = "0.83.1"
+graaf = "0.83.2"
 ```
 
 ## Digraph Types

src/algo/bellman_ford_moore.rs

@@ -9,7 +9,7 @@
 //!
 //! ## Shortest path
 //!
-//! Red highlights the shortest path between vertices 0 and 4.
+//! Red marks the shortest path between vertices `0` and `4`.
 //!
 //! ![Bellman-Ford-Moore](https://raw.githubusercontent.com/bsdrks/graaf-images/main/out/bellman_ford_moore_1.svg?)
 //!
@@ -41,7 +41,7 @@
 //!
 //! ## Negative cycle
 //!
-//! There is no shortest path from vertex 0 to vertex 2.
+//! There is no shortest path between  vertices `0` and `2`.
 //!
 //! ![Bellman-Ford-Moore](https://raw.githubusercontent.com/bsdrks/graaf-images/main/out/bellman_ford_moore_2.svg)
 //!
@@ -85,7 +85,7 @@ use crate::op::{
 ///
 /// ## Shortest path
 ///
-/// Red highlights the shortest path between vertices 0 and 4.
+/// Red marks the shortest path between vertices `0` and `4`.
 ///
 /// ![Bellman-Ford-Moore](https://raw.githubusercontent.com/bsdrks/graaf-images/main/out/bellman_ford_moore_1.svg?)
 ///
@@ -117,7 +117,7 @@ use crate::op::{
 ///
 /// ## Negative cycle
 ///
-/// There is no shortest path from vertex 0 to vertex 2.
+/// There is no shortest path between vertices `0` and `2`.
 ///
 /// ![Bellman-Ford-Moore](https://raw.githubusercontent.com/bsdrks/graaf-images/main/out/bellman_ford_moore_2.svg)
 ///

src/algo/bfs.rs

@@ -8,7 +8,8 @@
 //!
 //! ## Single source
 //!
-//! Red marks the path:
+//! Red marks the path starting at vertex `0` and `t` denotes the iteration
+//! index.
 //!
 //! ![BFS](https://raw.githubusercontent.com/bsdrks/graaf-images/main/out/bfs_1.svg?)
 //!
@@ -33,7 +34,8 @@
 //!
 //! ## Multiple sources
 //!
-//! Red marks the path starting at `3` and blue the path starting at `7`:
+//! Red marks the path starting at vertex `3` and blue the path starting at
+//! vertex `7`.
 //!
 //! ![BFS](https://raw.githubusercontent.com/bsdrks/graaf-images/main/out/bfs_multi_source_1.svg?)
 //!
@@ -73,7 +75,8 @@ use {
 ///
 /// # Examples
 ///
-/// Red marks the path:
+/// Red marks the path starting at vertex `0` and `t` denotes the iteration
+/// index.
 ///
 /// ![BFS](https://raw.githubusercontent.com/bsdrks/graaf-images/main/out/bfs_1.svg?)
 ///
@@ -98,7 +101,8 @@ use {
 ///
 /// ## Multiple sources
 ///
-/// Red marks the path starting at `3` and blue the path starting at `7`:
+/// Red marks the path starting at vertex `3` and blue the path starting at
+/// vertex `7`.
 ///
 /// ![BFS](https://raw.githubusercontent.com/bsdrks/graaf-images/main/out/bfs_multi_source_1.svg?)
 ///

src/algo/bfs_dist.rs

@@ -8,7 +8,7 @@
 //!
 //! ## Single source
 //!
-//! Red marks the path starting at `0`:
+//! Red marks the path starting at vertex `0` and `d` denotes the distance.
 //!
 //! ![BFS](https://raw.githubusercontent.com/bsdrks/graaf-images/main/out/bfs_dist_1.svg?)
 //!
@@ -42,7 +42,8 @@
 //!
 //! ## Multiple sources
 //!
-//! Red marks the path starting at `3` and blue the path starting at `7`:
+//! Red marks the path starting at vertex `3` and blue the path starting at
+//! vertex `7`.
 //!
 //! ![BFS](https://raw.githubusercontent.com/bsdrks/graaf-images/main/out/bfs_dist_multi_source_1.svg?)
 //!
@@ -97,7 +98,7 @@ use {
 ///
 /// ## Single source
 ///
-/// Red marks the path starting at `0`:
+/// Red marks the path starting at vertex `0` and `d` denotes the distance.
 ///
 /// ![BFS](https://raw.githubusercontent.com/bsdrks/graaf-images/main/out/bfs_dist_1.svg?)
 ///
@@ -131,7 +132,8 @@ use {
 ///
 /// ## Multiple sources
 ///
-/// Red marks the path starting at `3` and blue the path starting at `7`:
+/// Red marks the path starting at vertex `3` and blue the path starting at
+/// vertex `7`.
 ///
 /// ![BFS](https://raw.githubusercontent.com/bsdrks/graaf-images/main/out/bfs_dist_multi_source_1.svg?)
 ///