From 28e1adeb22ab5ab8c09681996beda444e843e7a6 Mon Sep 17 00:00:00 2001 From: fanghr Date: Wed, 11 May 2022 18:12:29 +0800 Subject: [PATCH] add some description for the governor spec tests --- agora-test/Spec/Governor.hs | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/agora-test/Spec/Governor.hs b/agora-test/Spec/Governor.hs index 10ce7be..0cd2557 100644 --- a/agora-test/Spec/Governor.hs +++ b/agora-test/Spec/Governor.hs @@ -1,9 +1,15 @@ {- | Module : Spec.Governor Maintainer : connor@mlabs.city -Description: Tests for Governor policy and validator +Description: Tests for Agora governor. -Tests for Governor policy and validator +Thie module exports `tests`, a list of `TestTree`s, which ensure +that Agora's governor component workds as intended. + +Tests should pass when the validator or policy is given one of the +valid script contexts, which are defined in 'Agora.Sample.Governor'. + +TODO: add negative test cases. -} module Spec.Governor (tests) where