Make doc comments in graph.rs more consistent

This commit is contained in:
Juno Takano 2026-01-21 21:02:16 -03:00
commit 95411ef605

View file

@ -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