Add a bunch of documentation.

[spline3.git] / src / Grid.hs

diff --git a/src/Grid.hs b/src/Grid.hs
index 3ca66ca7ddbde546bec6080b55637306b5232e8f..4b75185ad19b31b4922e5485105b069ec56dba96 100644 (file)
--- a/src/Grid.hs
+++ b/src/Grid.hs
@@ -29,9 +29,8 @@ empty_grid :: Grid
 empty_grid = Grid 1 [[[]]]
 
 
-
--- This is how we do a 'for' loop in Haskell.
--- No, seriously.
+-- | Returns a three-dimensional list of cubes centered on the grid
+--   points of g with the appropriate 'FunctionValues'.
 cubes :: Grid -> [[[Cube]]]
 cubes g
     | fvs == [[[]]] = [[[]]]
@@ -49,7 +48,7 @@ cubes g
 
 -- | Takes a grid and a position as an argument and returns the cube
 --   centered on that position. If there is no cube there (i.e. the
---   position is outside of the grid), it will return Nothing.
+--   position is outside of the grid), it will return 'Nothing'.
 cube_at :: Grid -> Int -> Int -> Int -> Maybe Cube
 cube_at g i j k
     | i < 0 = Nothing