From 2ccf946ccf0aa52185e27b86665cb4589046c066 Mon Sep 17 00:00:00 2001
From: mxhagen <markichnich@proton.me>
Date: Tue, 8 Apr 2025 21:04:51 +0200
Subject: [PATCH] doccomments

---
 src/graph.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/graph.rs b/src/graph.rs
index 606135a..62c67d1 100644
--- a/src/graph.rs
+++ b/src/graph.rs
@@ -290,6 +290,10 @@ where
         None
     }
 
+    /// find a path between two nodes using dijkstras algorithm.
+    ///
+    /// this take into account edge weights and finds a path with
+    /// the least total weight.
     pub fn find_path_dijkstra(&self, from: &V, to: &V) -> Option<Vec<V>> {
         use std::cmp::Reverse as Rev;
         use std::collections::BinaryHeap;