[Doc]

src/Data/Graph/Clustering/HLouvain.hs

@@ -29,7 +29,8 @@ import Data.Graph.Inductive
 glustering :: DynGraph gr
            => gr a b
            -> [Module]
-glustering = undefined
+glustering g = undefined
+
 
 ------------------------------------------------------------------------
 -- | Definitions
@@ -40,6 +41,7 @@ data Module = Module { node    :: Node
                      , score   :: Double
                      }
 
+-- | Divide en conquer method
 modulare :: DynGraph gr
          => gr a b
          ->  Module
@@ -54,6 +56,7 @@ modulare g m0@(Module n ms0 _) m1@(m@(Module n1 _ _):ms)
       score1 = sum $ map (modularity g) [m0, m]
       score2 = sum $ map (modularity g) ([m0]++ms)
 
+-- | need to flatten the Tree of modules to get a list of nodes
 flat :: Module -> [Node]
 flat (Module n [] _) = [n]
 flat (Module n ns _) = [n] ++ (concat $ map flat ns)