]> gitweb.michael.orlitzky.com - spline3.git/commitdiff
More minor doc fixes.
authorMichael Orlitzky <michael@orlitzky.com>
Sun, 8 May 2011 20:40:05 +0000 (16:40 -0400)
committerMichael Orlitzky <michael@orlitzky.com>
Sun, 8 May 2011 20:40:05 +0000 (16:40 -0400)
src/Comparisons.hs
src/FunctionValues.hs

index 4bf4cebb69ece2947eb1deccf0dfa9cfda20f266..b5d76d5b11d6da85ca386021be918041d83abd53 100644 (file)
@@ -3,8 +3,8 @@ module Comparisons
 where
 
 -- | epsilon is the value that will be used in all tests that require
---   some measure of "closeness." Increasing it will make those tests
---   more tolerant.
+--   some measure of \"closeness.\" Increasing it will make those
+--   tests more tolerant.
 epsilon :: Double
 epsilon = 0.0001
 
index 28f596b618e5dcd3c3c8acfb92103c2208691818..ed83f73336eac561b7d2450061ecd2bcf5709051 100644 (file)
@@ -8,8 +8,9 @@ import Prelude hiding (LT)
 import Cardinal
 
 -- | The FunctionValues type represents the value of our function f at
---   the 27 points surrounding the center of a cube. Each value of f
---   can be accessed by the name of its direction.
+--   the 27 points surrounding (and including) the center of a
+--   cube. Each value of f can be accessed by the name of its
+--   direction.
 data FunctionValues =
     FunctionValues { front  :: Double,
                      back   :: Double,
@@ -49,7 +50,7 @@ empty_values =
 --   FunctionValues type. Given a 'Cardinal' direction and a
 --   'FunctionValues' object, eval will return the value of the
 --   function f in that 'Cardinal' direction. Note that 'Cardinal' can
---   be a composite type; eval is what performs the "arithmetic" on
+--   be a composite type; eval is what performs the \"arithmetic\" on
 --   'Cardinal' directions.
 eval :: FunctionValues -> Cardinal -> Double
 eval f F = front f