From b943dddf1b0b9760a27e8aecb271d1d2ad7fa146 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stefan=20M=C3=BCller?= Date: Tue, 29 Sep 2026 23:19:08 +0200 Subject: [PATCH] Add docs for generators and generators::petersen --- src/generators.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/generators.rs b/src/generators.rs index 55f47a1..68fe60b 100644 --- a/src/generators.rs +++ b/src/generators.rs @@ -1,5 +1,13 @@ +//! Generators for common graphs. + use crate::traits::{GraphTopology, GraphTopologyAddition}; +/// Generates a Petersen graph. +/// +/// Generates a [Petersen graph] in `graph` as a new connected component and returns the new +/// vertices and edges. This graph is also the Kneser graph *KG(5, 2)*. +/// +/// [Petersen graph]: https://en.wikipedia.org/wiki/Petersen_graph pub fn petersen( graph: &mut G, ) -> (