on master help sign in
Update Array module docs
commit43fe60ee7a77347401bf999bb4ed6592412ba68c authorHarendra Kumar <harendra@composewell.com> dateThu 9 Mar 2023, 18:42 (4 years ago) parentc4ad0a5
1 file changed+4−6
core/src/Streamly/Data/Array.hs+4−6
core/src/Streamly/Data/Array.hs+4−6
@@ -13,9 +13,10 @@
1313-- array memory grows automatically when creating a new array, therefore, an
1414-- array can be created from a variable length stream.
1515--
16−-- See "Streamly.Data.Array.Generic" for arrays that work for boxed types i.e.
17−-- not requiring the 'Unbox' constraint.
18−-- See "Streamly.Data.MutArray" for arrays that can be mutated in-place..
16+-- See "Streamly.Internal.Data.Array" for more, unreleased APIs. See
17+-- "Streamly.Data.Array.Generic" for arrays that work for boxed types i.e. not
18+-- requiring the 'Unbox' constraint. See "Streamly.Data.MutArray" for arrays
19+-- that can be mutated in-place.
1920--
2021-- = Folding Arrays
2122--
@@ -77,9 +78,6 @@
7778--
7879-- >>> import qualified Streamly.Data.Array as Array
7980--
80−-- Use @QuantifiedConstraints@ extension to avoid the 'Storable' constraint
81−-- when using the 'Unbox' constraint.
82−--
8381-- For experimental APIs see "Streamly.Internal.Data.Array".
8482
8583module Streamly.Data.Array