summaryrefslogtreecommitdiff
path: root/libraries
diff options
context:
space:
mode:
authorBodigrim <andrew.lelechenko@gmail.com>2022-10-11 18:55:48 +0100
committerMarge Bot <ben+marge-bot@smart-cactus.org>2022-10-11 18:03:37 -0400
commitd3863cb7418b77f3cd49c219f1f42f64efb2cc93 (patch)
tree4cca14c50efc18488ccdf92a3e5879d32310a683 /libraries
parent9c099387ae82b7bf91232b714a3d35f429d6ffe3 (diff)
downloadhaskell-d3863cb7418b77f3cd49c219f1f42f64efb2cc93.tar.gz
ByteArray# is unlifted, not unboxed
Diffstat (limited to 'libraries')
-rw-r--r--libraries/base/Data/Array/Byte.hs8
1 files changed, 4 insertions, 4 deletions
diff --git a/libraries/base/Data/Array/Byte.hs b/libraries/base/Data/Array/Byte.hs
index 000af79eb4..549ca96bd7 100644
--- a/libraries/base/Data/Array/Byte.hs
+++ b/libraries/base/Data/Array/Byte.hs
@@ -30,11 +30,11 @@ import GHC.Show (intToDigit)
import GHC.ST (ST(..), runST)
import GHC.Word (Word8(..))
--- | Boxed wrapper for 'ByteArray#'.
+-- | Lifted wrapper for 'ByteArray#'.
--
-- Since 'ByteArray#' is an unlifted type and not a member of kind 'Data.Kind.Type',
-- things like @[ByteArray#]@ or @IO ByteArray#@ are ill-typed. To work around this
--- inconvenience this module provides a standard boxed wrapper, inhabiting 'Data.Kind.Type'.
+-- inconvenience this module provides a standard lifted wrapper, inhabiting 'Data.Kind.Type'.
-- Clients are expected to use 'ByteArray' in higher-level APIs,
-- but wrap and unwrap 'ByteArray' internally as they please
-- and use functions from "GHC.Exts".
@@ -42,11 +42,11 @@ import GHC.Word (Word8(..))
-- @since 4.17.0.0
data ByteArray = ByteArray ByteArray#
--- | Boxed wrapper for 'MutableByteArray#'.
+-- | Lifted wrapper for 'MutableByteArray#'.
--
-- Since 'MutableByteArray#' is an unlifted type and not a member of kind 'Data.Kind.Type',
-- things like @[MutableByteArray#]@ or @IO MutableByteArray#@ are ill-typed. To work around this
--- inconvenience this module provides a standard boxed wrapper, inhabiting 'Data.Kind.Type'.
+-- inconvenience this module provides a standard lifted wrapper, inhabiting 'Data.Kind.Type'.
-- Clients are expected to use 'MutableByteArray' in higher-level APIs,
-- but wrap and unwrap 'MutableByteArray' internally as they please
-- and use functions from "GHC.Exts".