From d60de7d5ab06d6c3261826b843ee89cf12ab9667 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Sun, 8 May 2011 16:40:05 -0400 Subject: [PATCH] More minor doc fixes. --- src/Comparisons.hs | 4 ++-- src/FunctionValues.hs | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/src/Comparisons.hs b/src/Comparisons.hs index 4bf4ceb..b5d76d5 100644 --- a/src/Comparisons.hs +++ b/src/Comparisons.hs @@ -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 diff --git a/src/FunctionValues.hs b/src/FunctionValues.hs index 28f596b..ed83f73 100644 --- a/src/FunctionValues.hs +++ b/src/FunctionValues.hs @@ -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 -- 2.43.2