on master help sign in
Update Array module docs
43fe60eHarendra Kumar
core/src/Streamly/Data/Array.hs+4−6
@@ -13,9 +13,10 @@
13-- array memory grows automatically when creating a new array, therefore, an
13-- array memory grows automatically when creating a new array, therefore, an
14-- array can be created from a variable length stream.
14-- array can be created from a variable length stream.
15--
15--
16+-- See "Streamly.Internal.Data.Array" for more, unreleased APIs. See
16−-- See "Streamly.Data.Array.Generic" for arrays that work for boxed types i.e.
17+-- "Streamly.Data.Array.Generic" for arrays that work for boxed types i.e. not
17−-- not requiring the 'Unbox' constraint.
18+-- requiring the 'Unbox' constraint. See "Streamly.Data.MutArray" for arrays
18−-- See "Streamly.Data.MutArray" for arrays that can be mutated in-place..
19+-- that can be mutated in-place.
19--
20--
20-- = Folding Arrays
21-- = Folding Arrays
21--
22--
@@ -77,9 +78,6 @@
77--
78--
78-- >>> import qualified Streamly.Data.Array as Array
79-- >>> import qualified Streamly.Data.Array as Array
79--
80--
80−-- Use @QuantifiedConstraints@ extension to avoid the 'Storable' constraint
81−-- when using the 'Unbox' constraint.
82−--
83-- For experimental APIs see "Streamly.Internal.Data.Array".
81-- For experimental APIs see "Streamly.Internal.Data.Array".
84
82
85module Streamly.Data.Array
83module Streamly.Data.Array