From 96b0cc0932ae090e263e4961c777b271cd3b5889 Mon Sep 17 00:00:00 2001 From: Alexey Khudyakov Date: Sun, 31 Mar 2024 22:43:46 +0300 Subject: [PATCH] Reword module comment for immutable strict vectors --- vector/src/Data/Vector/Strict.hs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/vector/src/Data/Vector/Strict.hs b/vector/src/Data/Vector/Strict.hs index d0e2c435..683c24f8 100644 --- a/vector/src/Data/Vector/Strict.hs +++ b/vector/src/Data/Vector/Strict.hs @@ -21,9 +21,11 @@ -- Portability : non-portable -- -- Immutable strict boxed vectors (that is, polymorphic arrays capable --- of holding any Haskell value). It is possible to create vector --- which contain bottom elements, either by using mutable interfaces --- (see "Data.Vector.Strict.Mutable") +-- of holding any Haskell value). Vectors created using API for +-- immutable vector will have all elements evaluated to WHNF. Note +-- it's possible to create vector containing bottoms using mutable API +-- ('Data.Vector.Strict.Mutable.new' initialize vector with ⊥) fill +-- but all subsequent writes will be evauated to WHNF. -- -- For unboxed arrays, use "Data.Vector.Unboxed". module Data.Vector.Strict (