add and fix haddock doc comments

This commit is contained in:
Emily Martins 2022-06-02 15:24:58 +02:00
parent 721c632b34
commit 0348f72499
10 changed files with 28 additions and 13 deletions

View file

@ -352,7 +352,7 @@ deriving via
instance
(PConstantDecl ProposalVotes)
-- Plutarch-level version of 'emptyVotesFor'.
-- | Plutarch-level version of 'emptyVotesFor'.
pemptyVotesFor :: forall s a. (PIsData a) => Term s (PMap PResultTag a :--> PProposalVotes)
pemptyVotesFor =
phoistAcyclic $
@ -451,7 +451,7 @@ proposalDatumValid proposal =
, ptraceIfFalse "Proposal votes and effects are compatible with each other" $ pkeysEqual # datum.effects # pto (pfromData datum.votes)
]
{- Find the winner result tag, given the votes, the quorum the "neutral" result tag.
{- | Find the winner result tag, given the votes, the quorum the "neutral" result tag.
The winner should be unambiguous, meaning that if two options have the same highest votes,
the "neutral" option will be the winner.