[mmzk] (doc) Fix some comment typoes

Never fully trust copilot, not even on comments!
MMZK1526 · Apr 19, 2024 · 545a88c · 545a88c
1 parent 8613882
commit 545a88c
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 27 deletions.
diff --git a/src/Data/KindID/V1.hs b/src/Data/KindID/V1.hs
@@ -105,24 +105,24 @@ toByteString :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
 toByteString = KID.toByteString
 {-# INLINE toByteString #-}
 
--- | Parse a 'KindIDV1' from its 'String' representation. It is 'parseString'
--- with concrete type.
+-- | Parse a 'KindIDV1' from its 'String' representation. It is 'string2ID' with
+-- concrete type.
 parseString :: forall prefix
              . (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
             => String -> Either TypeIDError (KindIDV1 prefix)
 parseString = KID.parseString
 {-# INLINE parseString #-}
 
 -- | Parse a 'KindIDV1' from its string representation as a strict 'Text'. It is
--- 'parseText' with concrete type.
+-- 'text2ID' with concrete type.
 parseText :: forall prefix
            . (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
           => Text -> Either TypeIDError (KindIDV1 prefix)
 parseText = KID.parseText
 {-# INLINE parseText #-}
 
 -- | Parse a 'KindIDV1' from its string representation as a lazy 'ByteString'.
--- It is 'parseByteString' with concrete type.
+-- It is 'byteString2ID' with concrete type.
 parseByteString :: forall prefix
                  . (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
                 => ByteString -> Either TypeIDError (KindIDV1 prefix)
@@ -137,15 +137,15 @@ parseStringM = KID.parseStringM
 
 -- | Parse a 'KindIDV1' from its string representation as a strict 'Text',
 -- throwing an error when the parsing fails. It is 'text2IDM' with concrete
--- type. It is 'parseTextM' with concrete type.
+-- type.
 parseTextM :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix), MonadIO m)
            => Text -> m (KindIDV1 prefix)
 parseTextM = KID.parseTextM
 {-# INLINE parseTextM #-}
 
 -- | Parse a 'KindIDV1' from its string representation as a lazy 'ByteString',
 -- throwing an error when the parsing fails. It is 'byteString2IDM' with
--- concrete type. It is 'parseByteStringM' with concrete type.
+-- concrete type.
 parseByteStringM :: ( ToPrefix prefix
                     , ValidPrefix (PrefixSymbol prefix)
                     , MonadIO m )
@@ -159,7 +159,8 @@ toTypeID :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
 toTypeID = KID.toTypeID
 {-# INLINE toTypeID #-}
 
--- | Convert a 'TypeIDV1' to a 'KindIDV1'.
+-- | Convert a 'TypeIDV1' to a 'KindIDV1'. Returns 'Nothing' if the prefix does
+-- not match.
 fromTypeID :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
            => TypeIDV1 -> Maybe (KindIDV1 prefix)
 fromTypeID = KID.fromTypeID

diff --git a/src/Data/KindID/V4.hs b/src/Data/KindID/V4.hs
@@ -113,24 +113,24 @@ toByteString :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
 toByteString = KID.toByteString
 {-# INLINE toByteString #-}
 
--- | Parse a 'KindIDV4' from its 'String' representation. It is 'parseString'
--- with concrete type.
+-- | Parse a 'KindIDV4' from its 'String' representation. It is 'string2ID' with
+-- concrete type.
 parseString :: forall prefix
              . (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
             => String -> Either TypeIDError (KindIDV4 prefix)
 parseString = KID.parseString
 {-# INLINE parseString #-}
 
 -- | Parse a 'KindIDV4' from its string representation as a strict 'Text'. It is
--- 'parseText' with concrete type.
+-- 'text2ID' with concrete type.
 parseText :: forall prefix
            . (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
           => Text -> Either TypeIDError (KindIDV4 prefix)
 parseText = KID.parseText
 {-# INLINE parseText #-}
 
 -- | Parse a 'KindIDV4' from its string representation as a lazy 'ByteString'.
--- It is 'parseByteString' with concrete type.
+-- It is 'byteString2ID' with concrete type.
 parseByteString :: forall prefix
                  . (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
                 => ByteString -> Either TypeIDError (KindIDV4 prefix)
@@ -145,15 +145,15 @@ parseStringM = KID.parseStringM
 
 -- | Parse a 'KindIDV4' from its string representation as a strict 'Text',
 -- throwing an error when the parsing fails. It is 'text2IDM' with concrete
--- type. It is 'parseTextM' with concrete type.
+-- type.
 parseTextM :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix), MonadIO m)
            => Text -> m (KindIDV4 prefix)
 parseTextM = KID.parseTextM
 {-# INLINE parseTextM #-}
 
 -- | Parse a 'KindIDV4' from its string representation as a lazy 'ByteString',
 -- throwing an error when the parsing fails. It is 'byteString2IDM' with
--- concrete type. It is 'parseByteStringM' with concrete type.
+-- concrete type.
 parseByteStringM :: ( ToPrefix prefix
                     , ValidPrefix (PrefixSymbol prefix)
                     , MonadIO m )
@@ -167,7 +167,8 @@ toTypeID :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
 toTypeID = KID.toTypeID
 {-# INLINE toTypeID #-}
 
--- | Convert a 'TypeIDV4' to a 'KindIDV4'.
+-- | Convert a 'TypeIDV4' to a 'KindIDV4'. Returns 'Nothing' if the prefix does
+-- not match.
 fromTypeID :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
            => TypeIDV4 -> Maybe (KindIDV4 prefix)
 fromTypeID = KID.fromTypeID

diff --git a/src/Data/KindID/V5.hs b/src/Data/KindID/V5.hs
@@ -106,24 +106,24 @@ toByteString :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
 toByteString = KID.toByteString
 {-# INLINE toByteString #-}
 
--- | Parse a 'KindIDV5' from its 'String' representation. It is 'parseString'
--- with concrete type.
+-- | Parse a 'KindIDV5' from its 'String' representation. It is 'string2ID' with
+-- concrete type.
 parseString :: forall prefix
              . (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
             => String -> Either TypeIDError (KindIDV5 prefix)
 parseString = KID.parseString
 {-# INLINE parseString #-}
 
 -- | Parse a 'KindIDV5' from its string representation as a strict 'Text'. It is
--- 'parseText' with concrete type.
+-- 'text2ID' with concrete type.
 parseText :: forall prefix
            . (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
           => Text -> Either TypeIDError (KindIDV5 prefix)
 parseText = KID.parseText
 {-# INLINE parseText #-}
 
 -- | Parse a 'KindIDV5' from its string representation as a lazy 'ByteString'.
--- It is 'parseByteString' with concrete type.
+-- It is 'byteString2ID' with concrete type.
 parseByteString :: forall prefix
                  . (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
                 => ByteString -> Either TypeIDError (KindIDV5 prefix)
@@ -138,15 +138,15 @@ parseStringM = KID.parseStringM
 
 -- | Parse a 'KindIDV5' from its string representation as a strict 'Text',
 -- throwing an error when the parsing fails. It is 'text2IDM' with concrete
--- type. It is 'parseTextM' with concrete type.
+-- type.
 parseTextM :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix), MonadIO m)
            => Text -> m (KindIDV5 prefix)
 parseTextM = KID.parseTextM
 {-# INLINE parseTextM #-}
 
 -- | Parse a 'KindIDV5' from its string representation as a lazy 'ByteString',
 -- throwing an error when the parsing fails. It is 'byteString2IDM' with
--- concrete type. It is 'parseByteStringM' with concrete type.
+-- concrete type.
 parseByteStringM :: ( ToPrefix prefix
                     , ValidPrefix (PrefixSymbol prefix)
                     , MonadIO m )
@@ -160,7 +160,8 @@ toTypeID :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
 toTypeID = KID.toTypeID
 {-# INLINE toTypeID #-}
 
--- | Convert a 'TypeIDV5' to a 'KindIDV5'.
+-- | Convert a 'TypeIDV5' to a 'KindIDV5'. Returns 'Nothing' if the prefix does
+-- not match.
 fromTypeID :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
            => TypeIDV5 -> Maybe (KindIDV5 prefix)
 fromTypeID = KID.fromTypeID

diff --git a/src/Data/KindID/V7.hs b/src/Data/KindID/V7.hs
@@ -147,24 +147,24 @@ toByteString :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
 toByteString = KID.toByteString
 {-# INLINE toByteString #-}
 
--- | Parse a 'KindID' from its 'String' representation. It is 'parseString'
--- with concrete type.
+-- | Parse a 'KindID' from its 'String' representation. It is 'string2ID' with
+-- concrete type.
 parseString :: forall prefix
              . (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
             => String -> Either TypeIDError (KindID prefix)
 parseString = KID.parseString
 {-# INLINE parseString #-}
 
 -- | Parse a 'KindID' from its string representation as a strict 'Text'. It is
--- 'parseText' with concrete type.
+-- 'text2ID' with concrete type.
 parseText :: forall prefix
            . (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
           => Text -> Either TypeIDError (KindID prefix)
 parseText = KID.parseText
 {-# INLINE parseText #-}
 
 -- | Parse a 'KindID' from its string representation as a lazy 'ByteString'. It
--- is 'parseByteString' with concrete type.
+-- is 'byteString2ID' with concrete type.
 parseByteString :: forall prefix
                  . (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix))
                 => ByteString -> Either TypeIDError (KindID prefix)
@@ -179,15 +179,15 @@ parseStringM = KID.parseStringM
 
 -- | Parse a 'KindID' from its string representation as a strict 'Text',
 -- throwing an error when the parsing fails. It is 'text2IDM' with concrete
--- type. It is 'parseTextM' with concrete type.
+-- type.
 parseTextM :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix), MonadIO m)
            => Text -> m (KindID prefix)
 parseTextM = KID.parseTextM
 {-# INLINE parseTextM #-}
 
 -- | Parse a 'KindID' from its string representation as a lazy 'ByteString',
 -- throwing an error when the parsing fails. It is 'byteString2IDM' with
--- concrete type. It is 'parseByteStringM' with concrete type.
+-- concrete type.
 parseByteStringM :: ( ToPrefix prefix
                     , ValidPrefix (PrefixSymbol prefix)
                     , MonadIO m )