@@ -322,18 +322,36 @@ impl PregelBuilder {
322322 ///
323323 /// # Examples
324324 ///
325- /// ```ignore
326- /// let vertices = ...
327- /// let edges = ...
328- ///
329- /// let pregel = PregelBuilder::new(GraphFrame::new(vertices, edges)?)
330- /// .max_iterations(4)
331- /// .with_vertex_column(Custom("max_value".to_owned()))
332- /// .initial_message(col(Custom("value".to_owned()).as_ref()))
333- /// .send_messages(MessageReceiver::Dst, Pregel::src(Custom("max_value".to_owned())))
334- /// .aggregate_messages(Pregel::msg(None).max())
335- /// .v_prog(max_exprs([col(Custom("max_value".to_owned()).as_ref()), Pregel::msg(None)]))
336- /// .build();
325+ /// ```rust
326+ /// use polars::prelude::*;
327+ /// use pregel_rs::graph_frame::GraphFrame;
328+ /// use pregel_rs::pregel::ColumnIdentifier::{Custom, Dst, Id, Src};
329+ /// use pregel_rs::pregel::{MessageReceiver, Pregel, PregelBuilder};
330+ /// use std::error::Error;
331+ ///
332+ /// // Simple example of a Pregel algorithm that finds the maximum value in a graph.
333+ /// fn main() -> Result<(), Box<dyn Error>> {
334+ /// let edges = df![
335+ /// Src.as_ref() => [0, 1, 1, 2, 2, 3],
336+ /// Dst.as_ref() => [1, 0, 3, 1, 3, 2],
337+ /// ]?;
338+ ///
339+ /// let vertices = df![
340+ /// Id.as_ref() => [0, 1, 2, 3],
341+ /// Custom("value".to_owned()).as_ref() => [3, 6, 2, 1],
342+ /// ]?;
343+ ///
344+ /// let pregel = PregelBuilder::new(GraphFrame::new(vertices, edges)?)
345+ /// .max_iterations(4)
346+ /// .with_vertex_column(Custom("max_value".to_owned()))
347+ /// .initial_message(col(Custom("value".to_owned()).as_ref()))
348+ /// .send_messages(MessageReceiver::Dst, Pregel::src(Custom("max_value".to_owned())))
349+ /// .aggregate_messages(Pregel::msg(None).max())
350+ /// .v_prog(max_exprs([col(Custom("max_value".to_owned()).as_ref()), Pregel::msg(None)]))
351+ /// .build();
352+ ///
353+ /// Ok(println!("{}", pregel.run()?))
354+ /// }
337355 /// ```
338356 ///
339357 /// Returns:
0 commit comments