Skip to content

Commit

Permalink
Merge pull request #8252 from mpilgrem/abihash-docs
Browse files Browse the repository at this point in the history
Fix Haddocks for `unAbiHash` and `mkAbiHash`
  • Loading branch information
mergify[bot] authored Jun 24, 2022
2 parents 8f6af47 + fb060cc commit 0a2e68c
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions Cabal-syntax/src/Distribution/Types/AbiHash.hs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ import Text.PrettyPrint (text)
newtype AbiHash = AbiHash ShortText
deriving (Eq, Show, Read, Generic, Typeable)

-- | Convert 'AbiHash' to 'String'
--
-- @since 2.0.0.2
unAbiHash :: AbiHash -> String
unAbiHash (AbiHash h) = fromShortText h

-- | Construct a 'AbiHash' from a 'String'
--
-- 'mkAbiHash' is the inverse to 'unAbiHash'
Expand All @@ -35,12 +41,6 @@ newtype AbiHash = AbiHash ShortText
-- 'AbiHash' is valid
--
-- @since 2.0.0.2
unAbiHash :: AbiHash -> String
unAbiHash (AbiHash h) = fromShortText h

-- | Convert 'AbiHash' to 'String'
--
-- @since 2.0.0.2
mkAbiHash :: String -> AbiHash
mkAbiHash = AbiHash . toShortText

Expand Down

0 comments on commit 0a2e68c

Please sign in to comment.