]> gitweb.michael.orlitzky.com - spline3.git/commitdiff
Fix two minor documentation issues.
authorMichael Orlitzky <michael@orlitzky.com>
Sun, 8 May 2011 20:36:36 +0000 (16:36 -0400)
committerMichael Orlitzky <michael@orlitzky.com>
Sun, 8 May 2011 20:36:36 +0000 (16:36 -0400)
src/Assertions.hs
src/Cardinal.hs

index 44d793b989be2f4eb83955995adfca976e4cfb9b..b51c25286491c90a506882a78373af6f1f80cd94 100644 (file)
@@ -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)
index b911003b7d6cfaedff1f31ba6179208422c6c6b4..9bd8e1df933b592d877d2e1efe810b44d96092ac 100644 (file)
@@ -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