Add missing module documentation files

Author: garyb

docs/Data.Array.ST.md

@@ -0,0 +1,113 @@
+## Module Data.Array.ST
+
+Helper functions for working with mutable arrays using the `ST` effect.
+
+This module can be used when performance is important and mutation is a local effect.
+
+#### `STArray`
+
+``` purescript
+data STArray :: * -> * -> *
+```
+
+A reference to a mutable array.
+
+The first type parameter represents the memory region which the array belongs to.
+The second type parameter defines the type of elements of the mutable array.
+
+The runtime representation of a value of type `STArray h a` is the same as that of `[a]`,
+except that mutation is allowed.
+
+#### `Assoc`
+
+``` purescript
+type Assoc a = { value :: a, index :: Int }
+```
+
+An element and its index
+
+#### `runSTArray`
+
+``` purescript
+runSTArray :: forall a r. (forall h. Eff (st :: ST h | r) (STArray h a)) -> Eff r (Array a)
+```
+
+Freeze a mutable array, creating an immutable array. Use this function as you would use
+`runST` to freeze a mutable reference.
+
+The rank-2 type prevents the reference from escaping the scope of `runSTArray`.
+
+#### `emptySTArray`
+
+``` purescript
+emptySTArray :: forall a h r. Eff (st :: ST h | r) (STArray h a)
+```
+
+Create an empty mutable array.
+
+#### `thaw`
+
+``` purescript
+thaw :: forall a h r. Array a -> Eff (st :: ST h | r) (STArray h a)
+```
+
+Create a mutable copy of an immutable array.
+
+#### `freeze`
+
+``` purescript
+freeze :: forall a h r. STArray h a -> Eff (st :: ST h | r) (Array a)
+```
+
+Create an immutable copy of a mutable array.
+
+#### `peekSTArray`
+
+``` purescript
+peekSTArray :: forall a h r. STArray h a -> Int -> Eff (st :: ST h | r) (Maybe a)
+```
+
+Read the value at the specified index in a mutable array.
+
+#### `pokeSTArray`
+
+``` purescript
+pokeSTArray :: forall a h r. STArray h a -> Int -> a -> Eff (st :: ST h | r) Boolean
+```
+
+Change the value at the specified index in a mutable array.
+
+#### `pushSTArray`
+
+``` purescript
+pushSTArray :: forall a h r. STArray h a -> a -> Eff (st :: ST h | r) Int
+```
+
+Append an element to the end of a mutable array.
+
+#### `pushAllSTArray`
+
+``` purescript
+pushAllSTArray :: forall a h r. STArray h a -> Array a -> Eff (st :: ST h | r) Int
+```
+
+Append the values in an immutable array to the end of a mutable array.
+
+#### `spliceSTArray`
+
+``` purescript
+spliceSTArray :: forall a h r. STArray h a -> Int -> Int -> Array a -> Eff (st :: ST h | r) (Array a)
+```
+
+Remove and/or insert elements from/into a mutable array at the specified index.
+
+#### `toAssocArray`
+
+``` purescript
+toAssocArray :: forall a h r. STArray h a -> Eff (st :: ST h | r) (Array (Assoc a))
+```
+
+Create an immutable copy of a mutable array, where each element
+is labelled with its index in the original array.
+
+

docs/Data.Array.Unsafe.md

@@ -0,0 +1,58 @@
+## Module Data.Array.Unsafe
+
+Unsafe helper functions for working with immutable arrays.
+
+_Note_: these functions should be used with care, and may result in unspecified
+behavior, including runtime exceptions.
+
+#### `unsafeIndex`
+
+``` purescript
+unsafeIndex :: forall a. Array a -> Int -> a
+```
+
+Find the element of an array at the specified index.
+
+Note: this function can cause unpredictable failure at runtime if the index is out-of-bounds.
+
+#### `head`
+
+``` purescript
+head :: forall a. Array a -> a
+```
+
+Get the first element of a non-empty array.
+
+Running time: `O(1)`.
+
+#### `tail`
+
+``` purescript
+tail :: forall a. Array a -> Array a
+```
+
+Get all but the first element of a non-empty array.
+
+Running time: `O(n)`, where `n` is the length of the array.
+
+#### `last`
+
+``` purescript
+last :: forall a. Array a -> a
+```
+
+Get the last element of a non-empty array.
+
+Running time: `O(1)`.
+
+#### `init`
+
+``` purescript
+init :: forall a. Array a -> Array a
+```
+
+Get all but the last element of a non-empty array.
+
+Running time: `O(n)`, where `n` is the length of the array.
+
+

gulpfile.js

@@ -47,7 +47,9 @@ gulp.task("docs", ["clean-docs"], function () {
     .pipe(plumber())
     .pipe(purescript.pscDocs({
       docgen: {
-        "Data.Array": "docs/Data.Array.md"
+        "Data.Array": "docs/Data.Array.md",
+        "Data.Array.ST": "docs/Data.Array.ST.md",
+        "Data.Array.Unsafe": "docs/Data.Array.Unsafe.md"
       }
     }));
 });