Haddock for boxed vectors

Shimuuar · Dec 14, 2024 · d9d33bb · d9d33bb
1 parent aa1d98c
commit d9d33bb
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/fixed-vector/Data/Vector/Fixed/Boxed.hs b/fixed-vector/Data/Vector/Fixed/Boxed.hs
@@ -1,7 +1,8 @@
 {-# LANGUAGE MagicHash            #-}
 {-# LANGUAGE UndecidableInstances #-}
 -- |
--- Vector which could hold any value.
+-- Lazy vector which could hold any value. For strict variant see
+-- "Data.Vector.Fixed.Strict".
 module Data.Vector.Fixed.Boxed (
     -- * Immutable
     Vec
@@ -38,7 +39,8 @@ import           Data.Vector.Fixed.Cont     (ArityPeano(..))
 -- Data type
 ----------------------------------------------------------------
 
--- | Vector with fixed length which can hold any value.
+-- | Vector with fixed length which can hold any value. It's lazy and
+--   doesn't evaluate elements.
 newtype Vec (n :: Nat) a = Vec (SmallArray a)
 
 -- | Mutable unboxed vector with fixed length

diff --git a/fixed-vector/Data/Vector/Fixed/Strict.hs b/fixed-vector/Data/Vector/Fixed/Strict.hs
@@ -1,6 +1,8 @@
 {-# LANGUAGE MagicHash            #-}
 {-# LANGUAGE UndecidableInstances #-}
 -- |
+-- Strict boxed vector which could hold any value. For lazy variant see
+-- "Data.Vector.Fixed.Boxed".
 module Data.Vector.Fixed.Strict where
 
 import Control.Applicative  (Applicative(..))
@@ -27,8 +29,8 @@ import           Data.Vector.Fixed.Cont     (ArityPeano(..))
 -- Data type
 ----------------------------------------------------------------
 
--- | Vector with fixed length which can hold any value. It's strict in
---   its elements
+-- | Vector with fixed length which can hold any value. It's strict
+--   and ensures that elements are evaluated to WHNF.
 newtype Vec (n :: Nat) a = Vec (SmallArray a)
 
 -- | Mutable unboxed vector with fixed length