Clarify that ChainSync-client-bench is comparative

IntersectMBO · Dec 4, 2024 · 8e3d8dd · 8e3d8dd
1 parent d613d97
commit 8e3d8dd
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/ouroboros-consensus/bench/ChainSync-client-bench/Main.hs b/ouroboros-consensus/bench/ChainSync-client-bench/Main.hs
@@ -1,6 +1,10 @@
 {-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE NamedFieldPuns #-}
 
+-- | This is a comparative benchmark that can be used to spot regressions in the
+-- Chain Sync Client. It is not a benchmark intended to provide an absolute
+-- measure of performance. For that, it would arguably need to use Cardano
+-- blocks instead of Test Blocks
 module Main (main) where
 
 import           Bench.Consensus.ChainSyncClient.Driver (mainWith)