fix docstrings

This commit is contained in:
Hongrui Fang 2022-10-07 10:23:07 +08:00
parent 8f2d8d6a15
commit 851bc8fc8d
No known key found for this signature in database
GPG key ID: F10AB2CCE24113DD
4 changed files with 23 additions and 16 deletions

View file

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

View file

@ -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
-}

View file

@ -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
-}

View file

@ -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