warrence/grapherity
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add mention of generators module in lib docs and readme

Browse Source
This commit is contained in:
warrence
2026-11-07 00:57:48 +01:00
parent 783a82fc18
commit 7c454afc23
2 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1
View File
@@ -9,6 +9,7 @@ Currently supported are:
* Undirected graph types `Graph`, `AppendGraph`, and `FrozenGraph`, built on a flat, index-based adjacency list, * Undirected graph types `Graph`, `AppendGraph`, and `FrozenGraph`, built on a flat, index-based adjacency list,
* `ElementMap` to freely associate custom data with vertices and edges, * `ElementMap` to freely associate custom data with vertices and edges,
* Connectivity and pathing algorithms: Dijkstra's algorithm, DFS, and BFS in different variants, * Connectivity and pathing algorithms: Dijkstra's algorithm, DFS, and BFS in different variants,
* Generators to build common graphs.
* Exposed traits to implement custom graph data structures or algorithms. * Exposed traits to implement custom graph data structures or algorithms.
For more information, see the [documentation](https://docs.rs/grapherity/latest/grapherity/). For more information, see the [documentation](https://docs.rs/grapherity/latest/grapherity/).
src/lib.rs
+2
View File
@@ -10,6 +10,7 @@
//! * [`ElementMap`] to freely associate custom data with vertices and edges, //! * [`ElementMap`] to freely associate custom data with vertices and edges,
//! * Connectivity and pathing algorithms: [Dijkstra's algorithm], [DFS], and [BFS] in different //! * Connectivity and pathing algorithms: [Dijkstra's algorithm], [DFS], and [BFS] in different
//! variants, //! variants,
//! * [Generators] to build common graphs.
//! * Exposed [`traits`] to implement custom graph data structures or algorithms. //! * Exposed [`traits`] to implement custom graph data structures or algorithms.
//! //!
//! # Usage example //! # Usage example
@@ -124,6 +125,7 @@
//! [BFS]: algorithms::bfs //! [BFS]: algorithms::bfs
//! [Dijkstra's algorithm]: algorithms::dijkstra //! [Dijkstra's algorithm]: algorithms::dijkstra
//! [DFS]: algorithms::dfs //! [DFS]: algorithms::dfs
//! [generators]: generators
//! [`ElementMap`]: maps::ElementMap //! [`ElementMap`]: maps::ElementMap
//! [`AppendGraph`]: models::AppendGraph //! [`AppendGraph`]: models::AppendGraph
//! [`FrozenGraph`]: models::FrozenGraph //! [`FrozenGraph`]: models::FrozenGraph