doccomments

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;