Add a comment to the benchmark scenario

cardano-scaling · Oct 10, 2024 · ec21ac0 · ec21ac0
1 parent a48d056
commit ec21ac0
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/hydra-cluster/bench/Bench/EndToEnd.hs b/hydra-cluster/bench/Bench/EndToEnd.hs
@@ -136,6 +136,8 @@ benchDemo networkId nodeSocket timeoutSeconds hydraClients workDir dataset@Datas
       returnAmount <- returnFundsToFaucet' faucetTracer node sk
       traceWith faucetTracer $ ReturnedFunds{returnAmount}
 
+-- | Runs the benchmark scenario given a list of clients. The first client is
+-- used to drive the life-cycle of the head.
 scenario ::
   Tracer IO HydraNodeLog ->
   RunningNode ->