fix docstrings

agora-specs/Property/Governor.hs

@@ -91,13 +91,21 @@ governorDatumValidProperty =
   classifiedPropertyNative gen (const []) expected classifier pisGovernorDatumValid
   where
     classifier :: GovernorDatum -> GovernorDatumCases
-    classifier ((.proposalThresholds) -> ProposalThresholds e c tv v co)
+    classifier
-      | e < 0 = ExecuteLE0
+      ( (.proposalThresholds) ->
-      | c < 0 = CreateLE0
+          ProposalThresholds
-      | tv < 0 = ToVotingLE0
+            execute
-      | v < 0 = VoteLE0
+            create
-      | co < 0 = CosignLE0
+            toVoting
-      | otherwise = Correct
+            vote
+            cosign
+        )
+        | execute < 0 = ExecuteLE0
+        | create < 0 = CreateLE0
+        | toVoting < 0 = ToVotingLE0
+        | vote < 0 = VoteLE0
+        | cosign < 0 = CosignLE0
+        | otherwise = Correct
 
     expected :: GovernorDatum -> Maybe Bool
     expected c = Just $ classifier c == Correct

agora/Agora/Proposal.hs

@@ -814,7 +814,7 @@ pisEffectsVotesCompatible = phoistAcyclic $
   plam $ \((PM.pkeys @PList #) -> effectKeys) ((PM.pkeys #) . pto -> voteKeys) ->
     plistEquals # effectKeys # voteKeys
 
-{- | Retutns true if vote counts of /all/ the options are zero.
+{- | Returns true if vote counts of /all/ the options are zero.
 
    @since 0.2.0
 -}

agora/Agora/Stake.hs

@@ -610,7 +610,7 @@ data StakeRedeemerImpl = StakeRedeemerImpl
 
 --------------------------------------------------------------------------------
 
-{- | Retutn true if the stake was used to voted on the proposal.
+{- | Return true if the stake was used to voted on the proposal.
 
      @since 1.0.0
 -}
@@ -624,7 +624,7 @@ pisVoter =
             _ -> pconstant False
         )
 
-{- | Retutn true if the stake was used to create the proposal.
+{- | Return true if the stake was used to create the proposal.
 
      @since 1.0.0
 -}
@@ -638,7 +638,7 @@ pisCreator =
             _ -> pconstant False
         )
 
-{- | Retutn true if the stake was used to cosign the proposal.
+{- | Return true if the stake was used to cosign the proposal.
 
      @since 1.0.0
 -}

agora/Agora/Utils.hs

@@ -293,11 +293,6 @@ pmapMaybe = phoistAcyclic $
       )
       (const pnil)
 
--- -- | @since 1.0.0
-
--- -- | @since 1.0.0
--- ppureIf'
-
 infixl 3 #<|>
 
 -- | @since 1.0.0
@@ -334,6 +329,10 @@ ppureIf = phoistAcyclic $
       (ppure # x)
       pempty
 
+{- | Less then check using a `PComparator`.
+
+     @ since 1.0.0
+-}
 pltBy ::
   forall (a :: PType) (s :: S).
   Term