[commit: vector] simd: Documentation (8aff1d7)

[Geoffrey Mainland]

Repository : http://darcs.haskell.org/ghc.git/

On branch  : simd

http://hackage.haskell.org/trac/ghc/changeset/8aff1d72745c9f17f9c913bcb9c73d7264546769

>---------------------------------------------------------------

commit 8aff1d72745c9f17f9c913bcb9c73d7264546769
Author: Roman Leshchinskiy <rl at cse.unsw.edu.au>
Date:   Sat Dec 31 13:43:23 2011 +0000

    Documentation

>---------------------------------------------------------------

 Data/Vector/Generic/Mutable.hs |   14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/Data/Vector/Generic/Mutable.hs b/Data/Vector/Generic/Mutable.hs
index 62da9c8..91e7036 100644
--- a/Data/Vector/Generic/Mutable.hs
+++ b/Data/Vector/Generic/Mutable.hs
@@ -72,6 +72,20 @@ import Prelude hiding ( length, null, replicate, reverse, map, read,
 
 -- | Class of mutable vectors parametrised with a primitive state token.
 --
+-- Minimum complete implementation:
+--
+--   * 'basicLength'
+--
+--   * 'basicUnsafeSlice'
+--
+--   * 'basicOverlaps'
+--
+--   * 'basicUnsafeNew'
+--
+--   * 'basicUnsafeRead'
+--
+--   * 'basicUnsafeWrite'
+--
 class MVector v a where
   -- | Length of the mutable vector. This method should not be
   -- called directly, use 'length' instead.