From 32e0ee2b9e84cedcf2775352131a09d4a03efac1 Mon Sep 17 00:00:00 2001 From: Emily Martins Date: Thu, 24 Mar 2022 16:09:39 +0100 Subject: [PATCH] more docs --- agora-test/Spec.hs | 1 + agora-test/Spec/Stake.hs | 8 ++++++++ agora-test/Spec/Util.hs | 7 +++++++ 3 files changed, 16 insertions(+) diff --git a/agora-test/Spec.hs b/agora-test/Spec.hs index d326e84..502cb27 100644 --- a/agora-test/Spec.hs +++ b/agora-test/Spec.hs @@ -11,6 +11,7 @@ import Test.Tasty (defaultMain, testGroup) import Spec.Model.MultiSig qualified as MultiSig import Spec.Stake qualified as Stake +-- | The Agora test suite main :: IO () main = defaultMain $ diff --git a/agora-test/Spec/Stake.hs b/agora-test/Spec/Stake.hs index f432e1b..8064ddf 100644 --- a/agora-test/Spec/Stake.hs +++ b/agora-test/Spec/Stake.hs @@ -1,3 +1,10 @@ +{- | +Module : Spec.Stake +Maintainer : emi@haskell.fyi +Description: Tests for Stake policy and validator + +Tests for Stake policy and validator +-} module Spec.Stake (tests) where -------------------------------------------------------------------------------- @@ -20,6 +27,7 @@ import Spec.Util (policyFailsWith, policySucceedsWith, toDatum, validatorFailsWi -------------------------------------------------------------------------------- +-- | Stake tests tests :: [TestTree] tests = [ testGroup diff --git a/agora-test/Spec/Util.hs b/agora-test/Spec/Util.hs index 33f23be..e43f7f5 100644 --- a/agora-test/Spec/Util.hs +++ b/agora-test/Spec/Util.hs @@ -1,3 +1,10 @@ +{- | +Module : Spec.Util +Maintainer : emi@haskell.fyi +Description: Utility functions for testing Plutarch scripts with ScriptContext + +Utility functions for testing Plutarch scripts with ScriptContext +-} module Spec.Util ( -- * Testing utils scriptSucceeds,