fix up documentation

CHANGELOG.md

@@ -18,6 +18,7 @@ Version 0.1.10.0
         *   Successive values of those projections reaching a certain squared
             difference (Cauchy-inspired convergence)
     *   S-Number Criterion
+*   Add test suites
 
 Version 0.1.9.0
 ---------------

src/Numeric/EMD.hs

@@ -34,9 +34,9 @@
 -- 2.  We provide a vector of size of at least one.
 --
 -- There are many functions to convert unsized vectors to sized vectors in
--- "Data.Vector.Sized" and associated modules, including 'toSized' (for
--- when you know the size at compile-time) and 'withSized' (for when you
--- don't).
+-- "Data.Vector.Sized" and associated modules, including
+-- 'Data.Vector.Sized.toSized' (for when you know the size at compile-time)
+-- and 'Data.Vector.Sized.withSized' (for when you don't).
 --
 
 module Numeric.EMD (

src/Numeric/EMD/Internal/Pipe.hs

@@ -45,7 +45,7 @@ makeFree ''PipeF
 --
 -- Some specializations:
 --
--- *  A pipe is a /producer/ if @i@ is '()': it doesn't need anything to go
+-- *  A pipe is a /producer/ if @i@ is @()@: it doesn't need anything to go
 --    pump out items.
 --
 --    If a pipe is producer and @a@ is 'Void', it means that it will

src/Numeric/EMD/Internal/Sift.hs

@@ -61,6 +61,7 @@ instance Fractional a => Default (EMDOpts a) where
     def = defaultEO
 
 
+-- | Boundary conditions for splines.
 data BoundaryHandler
     -- | Clamp envelope at end points (Matlab implementation)
     = BHClamp

src/Numeric/EMD/Internal/Spline.hs

@@ -1,6 +1,6 @@
 {-# LANGUAGE ApplicativeDo                            #-}
 {-# LANGUAGE DataKinds                                #-}
-{-# LANGUAGE DeriveGeneric #-}
+{-# LANGUAGE DeriveGeneric                            #-}
 {-# LANGUAGE GADTs                                    #-}
 {-# LANGUAGE RecordWildCards                          #-}
 {-# LANGUAGE ScopedTypeVariables                      #-}

src/Numeric/HHT.hs

@@ -204,8 +204,8 @@ instance (Ord k, Num a) => Monoid (SumMap k a) where
 -- Takes a "binning" function to allow you to specify how specific you want
 -- your frequencies to be.
 --
--- See 'hhtSparseSpetrum' for a sparser version, and 'hhtDenseSpectrum' for
--- a denser version.
+-- See 'hhtSparseSpectrum' for a sparser version, and 'hhtDenseSpectrum'
+-- for a denser version.
 hhtSpectrum
     :: forall v n a k. (VG.Vector v a, KnownNat n, Ord k, Num a)
     => (a -> k)     -- ^ binning function.  takes rev/tick freq between 0 and 1.

test/Tests/EMD.hs

@@ -80,4 +80,3 @@ orthogProp eo = property $ withSize (Range.linear 8 10) $ \(_ :: Proxy n) -> do
   where
     indices :: [Int]
     indices = [1..]
-    -- tripping (CE xs) (emd @_ @_ @(2^n-1) eo . getCE) (Identity . CE . iemd)