apply Emily's suggestions

* add `PMaxTimeRangeWidth`
* several `Default` instances for testing
* a bunch of docstrings
* fix the tests/samples

agora-sample/Sample/Effect/GovernorMutation.hs

@@ -11,14 +11,22 @@ module Sample.Effect.GovernorMutation (
   mkEffectDatum,
 ) where
 
+--------------------------------------------------------------------------------
+
 import Agora.Effect.GovernorMutation (
   MutateGovernorDatum (..),
   mutateGovernorValidator,
  )
 import Agora.Governor (GovernorDatum (..))
 import Agora.Proposal (ProposalId (..), ProposalThresholds (..))
+
+--------------------------------------------------------------------------------
+
 import Plutarch.Api.V1 (mkValidator, validatorHash)
 import Plutarch.SafeMoney (Tagged (Tagged))
+
+--------------------------------------------------------------------------------
+
 import Plutus.V1.Ledger.Address (scriptHashAddress)
 import Plutus.V1.Ledger.Api (
   Address,
@@ -35,11 +43,12 @@ import Plutus.V1.Ledger.Api (
 import Plutus.V1.Ledger.Api qualified as Interval
 import Plutus.V1.Ledger.Value (AssetClass, assetClass)
 import Plutus.V1.Ledger.Value qualified as Value
+
+--------------------------------------------------------------------------------
+
 import Sample.Shared (
   authorityTokenSymbol,
-  defaultCreateProposalTimeRangeMaxDuration,
   defaultProposalThresholds,
-  defaultProposalTimingConfig,
   govAssetClass,
   govValidatorAddress,
   governor,
@@ -48,6 +57,12 @@ import Sample.Shared (
  )
 import Test.Util (datumPair, toDatumHash)
 
+--------------------------------------------------------------------------------
+
+import Data.Default.Class (Default (def))
+
+--------------------------------------------------------------------------------
+
 -- | The effect validator instance.
 effectValidator :: Validator
 effectValidator = mkValidator $ mutateGovernorValidator governor
@@ -103,8 +118,8 @@ mkEffectTxInfo newGovDatum =
         GovernorDatum
           { proposalThresholds = defaultProposalThresholds
           , nextProposalId = ProposalId 0
-          , proposalTimings = defaultProposalTimingConfig
-          , createProposalTimeRangeMaxDuration = defaultCreateProposalTimeRangeMaxDuration
+          , proposalTimings = def
+          , createProposalTimeRangeMaxWidth = def
           }
       governorInputDatum :: Datum
       governorInputDatum = Datum $ toBuiltinData governorInputDatum'
@@ -165,8 +180,8 @@ validNewGovernorDatum =
   GovernorDatum
     { proposalThresholds = defaultProposalThresholds
     , nextProposalId = ProposalId 42
-    , proposalTimings = defaultProposalTimingConfig
-    , createProposalTimeRangeMaxDuration = defaultCreateProposalTimeRangeMaxDuration
+    , proposalTimings = def
+    , createProposalTimeRangeMaxWidth = def
     }
 
 invalidNewGovernorDatum :: GovernorDatum
@@ -177,6 +192,6 @@ invalidNewGovernorDatum =
           { countVoting = Tagged (-1)
           }
     , nextProposalId = ProposalId 42
-    , proposalTimings = defaultProposalTimingConfig
-    , createProposalTimeRangeMaxDuration = defaultCreateProposalTimeRangeMaxDuration
+    , proposalTimings = def
+    , createProposalTimeRangeMaxWidth = def
     }