From: Michael Orlitzky <michael@orlitzky.com>
Date: Sun, 8 May 2011 20:36:36 +0000 (-0400)
Subject: Fix two minor documentation issues.
X-Git-Tag: 0.0.1~304
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=00a4dc471c4dc1c48c6012cc897c37d14a2f1644;p=spline3.git

Fix two minor documentation issues.
---

diff --git a/src/Assertions.hs b/src/Assertions.hs
index 44d793b..b51c252 100644
--- a/src/Assertions.hs
+++ b/src/Assertions.hs
@@ -11,7 +11,7 @@ import Comparisons
 import Point
 
 -- | An HUnit assertion that wraps the almost_equals function. Stolen
---   from the definition of 'assertEqual' in Test/HUnit/Base.hs.
+--   from the definition of 'assertEqual' in Test\/HUnit\/Base.hs.
 assertAlmostEqual :: String -> Double -> Double -> Assertion
 assertAlmostEqual preface expected actual =
   unless (actual ~= expected) (assertFailure msg)
@@ -20,7 +20,7 @@ assertAlmostEqual preface expected actual =
 
 
 -- | An HUnit assertion that wraps the is_close function. Stolen
---   from the definition of 'assertEqual' in Test/HUnit/Base.hs.
+--   from the definition of 'assertEqual' in Test\/HUnit\/Base.hs.
 assertClose :: String -> Point -> Point -> Assertion
 assertClose preface expected actual =
   unless (actual `is_close` expected) (assertFailure msg)
diff --git a/src/Cardinal.hs b/src/Cardinal.hs
index b911003..9bd8e1d 100644
--- a/src/Cardinal.hs
+++ b/src/Cardinal.hs
@@ -1,6 +1,6 @@
 -- | The Cardinal module contains the Cardinal data type, representing
---   a cardinal direction (one of the 27 directions surrounding the
---   center of a cube. In addition to those 27 directions, we also
+--   a cardinal direction (one of the 26 directions surrounding the
+--   center of a cube. In addition to those 26 directions, we also
 --   include the interior point and a number of composite types that
 --   allow us to perform arithmetic on directions.
 module Cardinal
@@ -60,7 +60,7 @@ instance Num Cardinal where
     fromInteger x = Scalar (fromIntegral x)
 
 
--- | Like the Num instance, the Fractional instance allows us to
+-- | Like the Num instance, the 'Fractional' instance allows us to
 --   take quotients of directions.
 instance Fractional Cardinal where
     x / y   = Quotient x y