[haddock] haddock builds correclty now

README.md

@@ -156,3 +156,12 @@ file format. To decode it to JSON and analyze, say, using
 ``` sh
 cat repos/repo.cbor.v5 | stack --nix exec gargantext-cbor2json | jq .
 ```
+### Documentation
+
+To build documentation, run:
+
+```sh
+stack --docker build --haddock --no-haddock-deps --fast
+```
+
+

src/Gargantext/Core/Text/List.hs

@@ -97,7 +97,7 @@ buildNgramsOthersList ::( HasNodeError err
 buildNgramsOthersList user uCid _groupParams (nt, MapListSize mapListSize) = do
   allTerms  :: HashMap NgramsTerm (Set NodeId) <- getNodesByNgramsUser uCid nt
 
-  -- | PrivateFirst for first developments since Public NodeMode is not implemented yet
+  -- PrivateFirst for first developments since Public NodeMode is not implemented yet
   socialLists :: FlowCont NgramsTerm FlowListScores
     <- flowSocialList MySelfFirst user nt ( FlowCont HashMap.empty
                                                       $ HashMap.fromList
@@ -152,11 +152,11 @@ buildNgramsTermsList :: ( HasNodeError err
                         -> m (Map NgramsType [NgramsElement])
 buildNgramsTermsList user uCid mCid groupParams (nt, _mapListSize)= do
 
--- | Filter 0 With Double
+-- Filter 0 With Double
 -- Computing global speGen score
   allTerms :: HashMap NgramsTerm Double <- getTficf uCid mCid nt
 
-  -- | PrivateFirst for first developments since Public NodeMode is not implemented yet
+  -- PrivateFirst for first developments since Public NodeMode is not implemented yet
   socialLists :: FlowCont NgramsTerm FlowListScores
     <- flowSocialList MySelfFirst user nt ( FlowCont HashMap.empty
                                                       $ HashMap.fromList
@@ -215,7 +215,7 @@ buildNgramsTermsList user uCid mCid groupParams (nt, _mapListSize)= do
 
   printDebug "groupedTreeScores_SetNodeId" groupedTreeScores_SetNodeId
 
-  -- | Coocurrences computation
+  -- Coocurrences computation
   --, t1 >= t2 -- permute byAxis diag  -- since matrix symmetric
   let mapCooc = HashMap.filter (>1) -- removing cooc of 1
               $ HashMap.fromList [ ((t1, t2), Set.size $ Set.intersection s1 s2)
@@ -301,7 +301,7 @@ buildNgramsTermsList user uCid mCid groupParams (nt, _mapListSize)= do
 
   -- TODO count it too
     cands' = setListType (Just CandidateTerm)
-          {-$  groupedMonoTail
+          {-\$  groupedMonoTail
           <>-} groupedMultTail
 
     result = Map.unionsWith (<>)

src/Gargantext/Core/Text/List/Group/WithStem.hs

@@ -78,8 +78,8 @@ groupWith (GroupParams l _m _n _) t =
                   $ map (stem l)
                   -- . take n
                   $ List.sort
-                  -- $ Set.toList
-                  -- $ Set.fromList
+                  -- \$ Set.toList
+                  -- \$ Set.fromList
                   -- . (List.filter (\t -> Text.length t > m))
                   $ Text.splitOn " "
                   $ Text.replace "-" " "

src/Gargantext/Core/Text/List/Social/Patch.hs

@@ -69,10 +69,10 @@ Children are not modified in this specific case.
 -- New list get +1 score
 -- Hence others lists lay around 0 score
 addScorePatch fl (t, (NgramsPatch children' (Patch.Replace old_list new_list))) =
-  -- | Adding New Children score
+  -- Adding new 'Children' score
   addScorePatch fl' (t, NgramsPatch children' Patch.Keep)
     where
-      -- | Adding New ListType score
+      -- | Adding new 'ListType' score
       fl' = fl & flc_scores . at t %~ (score fls_listType old_list (-1))
           & flc_scores . at t %~ (score fls_listType new_list ( 1))
           & flc_cont   %~ (HashMap.delete t)

src/Gargantext/Core/Viz/Phylo/PhyloExport.hs

@@ -670,7 +670,7 @@ toPhyloExport phylo = exportToDot phylo
                $ processDynamics
                $ getGroupsFromLevel (phyloLevel $ getConfig phylo)
                $ tracePhyloInfo phylo
-               -- $ toHorizon phylo
+               -- \$ toHorizon phylo
 
 
 traceExportBranches :: [PhyloBranch] -> [PhyloBranch]

src/Gargantext/Database/Query/Tree.hs

@@ -256,7 +256,7 @@ toTree m =
                 -> Tree NodeTree
         toTree' m' root =
           TreeN (toNodeTree root) $
-            -- | Lines below are equivalent computationally but not semantically
+            -- Lines below are equivalent computationally but not semantically
             -- m' ^.. at (Just $ _dt_nodeId root) . _Just . each . to (toTree' m')
             toListOf (at (Just $ _dt_nodeId root) . _Just . each . to (toTree' m')) m'
 

src/Gargantext/Prelude/Crypto/Pass/User.hs

@@ -17,20 +17,20 @@ module Gargantext.Prelude.Crypto.Pass.User
       where
 
 
--- | 1) Quick password generator imports
+-- 1) Quick password generator imports
 import Data.Text (Text)
 import Data.String (String)
 import Control.Monad
 import Control.Monad.Random
 import qualified Data.List as List
 
--- | 2) Easy password manager imports
+-- 2) Easy password manager imports
 import Gargantext.Prelude
 import Gargantext.Prelude.Utils (shuffle)
 
 
--- | 1) Quick password generator
--- | Inspired by Rosetta code
+-- 1) Quick password generator
+-- Inspired by Rosetta code
 -- https://www.rosettacode.org/wiki/Password_generator#Haskell
 gargPass :: MonadRandom m => m Text
 gargPass = cs <$> gargPass' chars 33