Improve package description
authorRoman Leshchinskiy <rl@cse.unsw.edu.au>
Fri, 26 Aug 2011 23:22:44 +0000 (23:22 +0000)
committerRoman Leshchinskiy <rl@cse.unsw.edu.au>
Fri, 26 Aug 2011 23:22:44 +0000 (23:22 +0000)
vector.cabal

index be7c8d2..507264d 100644 (file)
@@ -12,24 +12,24 @@ Synopsis:       Efficient Arrays
 Description:
         .
         An efficient implementation of Int-indexed arrays (both mutable
-        and immutable), with a powerful loop fusion optimization framework .
+        and immutable), with a powerful loop optimisation framework .
         .
         It is structured as follows:
         .
-        [@Data.Vector@] Boxed vectors of arbitrary types.
+        ["Data.Vector"] Boxed vectors of arbitrary types.
         .
-        [@Data.Vector.Unboxed@] Unboxed vectors with an adaptive
+        ["Data.Vector.Unboxed"] Unboxed vectors with an adaptive
         representation based on data type families.
         .
-        [@Data.Vector.Storable@] Unboxed vectors of 'Storable' types.
+        ["Data.Vector.Storable"] Unboxed vectors of 'Storable' types.
         .
-        [@Data.Vector.Primitive@] Unboxed vectors of primitive types as
-        defined by the @primitive@ package. @Data.Vector.Unboxed@ is more
+        ["Data.Vector.Primitive"] Unboxed vectors of primitive types as
+        defined by the @primitive@ package. "Data.Vector.Unboxed" is more
         flexible at no performance cost.
         .
-        [@Data.Vector.Generic@] Generic interface to the vector types.
+        ["Data.Vector.Generic"] Generic interface to the vector types.
         .
-        Each module has a @Safe@ version with is marked as Trustworthy
+        Each module has a @Safe@ version with is marked as @Trustworthy@
         (see <http://hackage.haskell.org/trac/ghc/wiki/SafeHaskell>).
         .
         There is also a (draft) tutorial on common uses of vector.
@@ -51,13 +51,13 @@ Description:
         .
         * Safe Haskell support (contributed by David Terei)
         .
-        * Functor, Monad, Applicative, Alternative, Foldable and Traversable
-          instances for boxed vectors (WARNING: they tend to be slow and are
-          only provided for completeness)
+        * 'Functor', 'Monad', 'Applicative', 'Alternative', 'Foldable' and
+          'Traversable' instances for boxed vectors
+          (/WARNING: they tend to be slow and are only provided for completeness/)
         .
-        * Show instances for immutable vectors follow containers conventions
+        * 'Show' instances for immutable vectors follow containers conventions
         .
-        * Read instances for all immutable vector types
+        * 'Read' instances for all immutable vector types
         .
         * Performance improvements
         .