diff --git a/agora-specs/Sample/Governor.hs b/agora-specs/Sample/Governor.hs index 695526e..44d0105 100644 --- a/agora-specs/Sample/Governor.hs +++ b/agora-specs/Sample/Governor.hs @@ -1,5 +1,5 @@ {- | -Module : Spec.Sample.Governor +Module : Sample.Governor Maintainer : connor@mlabs.city Description: Sample based testing for Governor utxos diff --git a/agora-specs/Sample/Proposal/Advance.hs b/agora-specs/Sample/Proposal/Advance.hs index 7d7b673..73c2ab6 100644 --- a/agora-specs/Sample/Proposal/Advance.hs +++ b/agora-specs/Sample/Proposal/Advance.hs @@ -1,3 +1,10 @@ +{- | +Module : Sample.Proposal.Advance +Maintainer : connor@mlabs.city +Description: Generate sample data for testing the functionalities of advancing proposals + +Sample and utilities for testing the functionalities of advancing proposals. +-} module Sample.Proposal.Advance ( advanceToNextStateInTimeParameters, advanceToFailedStateDueToTimeoutParameters, diff --git a/agora-specs/Sample/Proposal/Cosign.hs b/agora-specs/Sample/Proposal/Cosign.hs index 3ce7609..f9a3865 100644 --- a/agora-specs/Sample/Proposal/Cosign.hs +++ b/agora-specs/Sample/Proposal/Cosign.hs @@ -1,3 +1,10 @@ +{- | +Module : Sample.Proposal.Cosign +Maintainer : connor@mlabs.city +Description: Generate sample data for testing the functionalities of cosigning proposals + +Sample and utilities for testing the functionalities of cosigning proposals. +-} module Sample.Proposal.Cosign ( Parameters (..), validCosignNParameters, diff --git a/agora-specs/Sample/Proposal/Create.hs b/agora-specs/Sample/Proposal/Create.hs index 44eacfa..3556256 100644 --- a/agora-specs/Sample/Proposal/Create.hs +++ b/agora-specs/Sample/Proposal/Create.hs @@ -1,3 +1,10 @@ +{- | +Module : Sample.Proposal.Create +Maintainer : connor@mlabs.city +Description: Generate sample data for testing the functionalities of creating proposals + +Sample and utilities for testing the functionalities of creating proposals. +-} module Sample.Proposal.Create ( Parameters (..), mkTestTree, diff --git a/agora-specs/Sample/Proposal/Shared.hs b/agora-specs/Sample/Proposal/Shared.hs index 21b2ce1..0082f68 100644 --- a/agora-specs/Sample/Proposal/Shared.hs +++ b/agora-specs/Sample/Proposal/Shared.hs @@ -1,3 +1,10 @@ +{- | +Module : Sample.Proposal.Shared +Maintainer : connor@mlabs.city +Description: Shared constants for propsoal samples + +Shared constants for propsoal samples. +-} module Sample.Proposal.Shared (proposalTxRef, stakeTxRef) where import PlutusLedgerApi.V1 (TxId) diff --git a/agora-specs/Sample/Proposal/UnlockStake.hs b/agora-specs/Sample/Proposal/UnlockStake.hs index 529e397..20b1be5 100644 --- a/agora-specs/Sample/Proposal/UnlockStake.hs +++ b/agora-specs/Sample/Proposal/UnlockStake.hs @@ -1,3 +1,10 @@ +{- | +Module : Sample.Proposal.UnlockStake +Maintainer : connor@mlabs.city +Description: Generate sample data for testing the functionalities of unlocking stake and retracting votes + +Sample and utilities for testing the functionalities of unlocking stake and retracting votes +-} module Sample.Proposal.UnlockStake ( StakeRole (..), Parameters (..), diff --git a/agora-specs/Sample/Proposal/Vote.hs b/agora-specs/Sample/Proposal/Vote.hs index c2af036..36ed93d 100644 --- a/agora-specs/Sample/Proposal/Vote.hs +++ b/agora-specs/Sample/Proposal/Vote.hs @@ -1,3 +1,10 @@ +{- | +Module : Sample.Proposal.Vote +Maintainer : connor@mlabs.city +Description: Generate sample data for testing the functionalities of voting on proposals. + +Sample and utilities for testing the functionalities of voting on proposals. +-} module Sample.Proposal.Vote ( validVoteParameters, mkTestTree,