Document runAllWorkers footgun

bin/gargantext-cli/CLI/Worker.hs

@@ -126,6 +126,15 @@ stats_p = fmap CLIW_stats $ WorkerStatsArgs
   <$> settings_p
 
 
+-- | Runs all the workers concurrently.
+-- /NOTE/: Be very careful, this IS a BLOCKING operation, despite its usage
+-- of 'forConcurrently_' under the hood. In particular 'forConcurrently_' will
+-- execute the inner action in parallel discarding the results, but the inner
+-- action has still to terminate!
+-- That is /NOT/ the case for this function, which is meant to start the infinite
+-- loop for the workers, so beware when using this, make sure that the calling
+-- code is using this properly (for example along the use of 'race' or a similar
+-- function from async).
 runAllWorkers :: Logger IO -> SettingsFile -> IO ()
 runAllWorkers ioLogger worker_toml = do
   cfg <- readConfig worker_toml