docs for computeBakerStakesAndCapital parameters

Concordium · Dec 9, 2024 · af93309 · af93309
1 parent 9646f20
commit af93309
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/concordium-consensus/src/Concordium/Kontrol/Bakers.hs b/concordium-consensus/src/Concordium/Kontrol/Bakers.hs
@@ -176,9 +176,15 @@ data BakerStakesAndCapital bakerInfoRef = BakerStakesAndCapital
 -- | Compute the baker stakes and capital distribution.
 computeBakerStakesAndCapital ::
     forall bakerInfoRef.
+    -- | Pool parameters
     PoolParameters' 'PoolParametersVersion1 ->
+    -- | Active validators
     [ActiveBakerInfo' bakerInfoRef] ->
+    -- | Passive delegators
     [ActiveDelegatorInfo] ->
+    -- | Validator ids that will be suspended during the snapshot transition
+    --  because they are primed, but are not yet marked as suspended in their
+    --  `ActiveBakerInfo`.
     Set.Set BakerId ->
     BakerStakesAndCapital bakerInfoRef
 computeBakerStakesAndCapital poolParams activeBakers passiveDelegators snapshotSuspendedBids = BakerStakesAndCapital{..}