Prepare for v1.0.1.0

CHANGELOG.md

@@ -65,8 +65,10 @@
 
 * Many more updates to the algorithms - see README for details
 
-## 1.0.1.0 -- XXXX-XX-XX
+## 1.0.1.0 -- 2024-08-22
 
 * Export more functions for building custom Tensort variants
 
-* Cleanup code and documentation
+* Cleanup and improve documentation
+
+* Cleanup code a bit

src/Data/Tensort/Utils/Compose.hs

@@ -1,6 +1,6 @@
 -- | Module for creating Tensors from Bytes and Tensors
 --
---   Functions ending in 'R' are for sorting Records when used in a recursive
+--   Functions ending in "R" are for sorting Records when used in a recursive
 --   Tensort variant
 --
 --   TODO: See if we can clean up the type conversion here

src/Data/Tensort/Utils/LogNat.hs

@@ -1,8 +1,10 @@
+-- | This module provides functions for calculating the natural logarithms in
+--   a way useful for creating logarithmic Bytesizes
 module Data.Tensort.Utils.LogNat (getLnBytesize, getLn) where
 
 import Data.Tensort.Utils.Types (Sortable (..))
 
--- | Calculate a logarithmic Bytesize from a Sortable
+-- | Calculate a suitable logarithmic Bytesize from a Sortable
 
 -- | ==== __Examples__
 -- >>> getLnBytesize (SortBit [1 .. 27])

src/Data/Tensort/Utils/Reduce.hs

@@ -1,7 +1,7 @@
 -- | This module provides functions to reduce a list of TensorStacks into a
 --   more compact list of TensorStacks
 --
---   Functions ending in 'R' are for sorting Records when used in a recursive
+--   Functions ending in "R" are for sorting Records when used in a recursive
 --   Tensort variant
 --
 --   TODO: See if we can clean up the type conversion here

src/Data/Tensort/Utils/Render.hs

@@ -1,6 +1,6 @@
 -- | Module for rendering a sorted list of Bits from a list of TensorStacks
 --
---   Functions ending in 'R' are for sorting Records when used in a recursive
+--   Functions ending in "R" are for sorting Records when used in a recursive
 --   Tensort variant
 --
 --   TODO: See if we can clean up the type conversion here

tensort.cabal

@@ -20,7 +20,7 @@ name:               tensort
 -- PVP summary:     +-+------- breaking API changes
 --                  | | +----- non-breaking API additions
 --                  | | | +--- code changes with no API change
-version:            1.0.0.0
+version:            1.0.1.0
 
 tested-with:        GHC==9.8.2, 
                     GHC==9.6.4, 
@@ -154,6 +154,7 @@ executable tensort
     -- Other library packages from which modules are imported.
     build-depends:
         base,
+        tensort,
 
     -- Directories containing source files.
     hs-source-dirs:   app