Skip to content

Commit 96b0cc0

Browse files
committed
Reword module comment for immutable strict vectors
1 parent db3529f commit 96b0cc0

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

vector/src/Data/Vector/Strict.hs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@
2121
-- Portability : non-portable
2222
--
2323
-- Immutable strict boxed vectors (that is, polymorphic arrays capable
24-
-- of holding any Haskell value). It is possible to create vector
25-
-- which contain bottom elements, either by using mutable interfaces
26-
-- (see "Data.Vector.Strict.Mutable")
24+
-- of holding any Haskell value). Vectors created using API for
25+
-- immutable vector will have all elements evaluated to WHNF. Note
26+
-- it's possible to create vector containing bottoms using mutable API
27+
-- ('Data.Vector.Strict.Mutable.new' initialize vector with ⊥) fill
28+
-- but all subsequent writes will be evauated to WHNF.
2729
--
2830
-- For unboxed arrays, use "Data.Vector.Unboxed".
2931
module Data.Vector.Strict (

0 commit comments

Comments
 (0)