From 95411ef605ad8d24c995a2eab0c99d008bf358e0 Mon Sep 17 00:00:00 2001 From: jutty Date: Wed, 21 Jan 2026 21:02:16 -0300 Subject: [PATCH] Make doc comments in graph.rs more consistent --- src/graph.rs | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/graph.rs b/src/graph.rs index 914914e..709859f 100644 --- a/src/graph.rs +++ b/src/graph.rs @@ -207,10 +207,10 @@ impl Graph { } } - // Modulates nodes that have been deserialized and are still unprocessed. - // - // Performs checked arithmetic to the following effect: - // - Stats will saturate at u32::MAX (increment_detached calls) + /// Modulates nodes that have been deserialized and are still unprocessed. + /// + /// Performs checked arithmetic to the following effect: + /// - Stats will saturate at `u32::MAX` (`increment_detached` calls) fn modulate_nodes(&mut self) { let in_nodes = self.nodes.clone(); @@ -310,10 +310,10 @@ impl Graph { } } - // Modulates edges that have been deserialized and are still unprocessed. - // - // This function performs checked arithmetic to the following effect: - // - Stats will saturate at u32::MAX + /// Modulates edges that have been deserialized and are still unprocessed. + /// + /// Performs checked arithmetic to the following effect: + /// - Stats will saturate at `u32::MAX` fn modulate_edges(&mut self) { let graph = self.clone(); let iterator = self.nodes.iter_mut(); @@ -372,10 +372,10 @@ impl Graph { } } - // Increments detached node statistics for the given node ID - // - // This function performs checked arithmetic to the following effect: - // - Stats will saturate at u32::MAX + /// Increments detached node statistics for the given node ID + /// + /// Performs checked arithmetic to the following effect: + /// - Stats will saturate at `u32::MAX` fn increment_detached(&mut self, node_id: &str) { self.stats .detached