Fixed doco for toFile functions

timbod7 · Aug 31, 2014 · c4521d8 · c4521d8
1 parent 473877e
commit c4521d8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/chart-cairo/Graphics/Rendering/Chart/Backend/Cairo.hs b/chart-cairo/Graphics/Rendering/Chart/Backend/Cairo.hs
@@ -185,9 +185,9 @@ renderableToFile fo path r = cBackendToFile fo cr path
     cr = render r (fromIntegral width, fromIntegral height)
     (width,height) = _fo_size fo
 
--- | Generate an image file from anything that can be converted to a renderable.
--- This is a convenience wrapper over `renderableToFile`
-
+-- | Generate an image file from from the state content of an EC
+-- computation. The state may have any type that is an instance of
+-- `ToRenderable`
 toFile :: (Default r, ToRenderable r) => FileOptions -> FilePath -> EC r () -> IO ()
 toFile fo path ec = void $ renderableToFile fo path (toRenderable (execEC ec))
 

diff --git a/chart-diagrams/Graphics/Rendering/Chart/Backend/Diagrams.hs b/chart-diagrams/Graphics/Rendering/Chart/Backend/Diagrams.hs
@@ -114,9 +114,9 @@ renderableToFile fo path r = cBackendToFile fo cb path
   where
     cb = render r (_fo_size fo)
 
--- | Generate an image file from anything that can be converted to a renderable.
--- This is a convenience wrapper over `renderableToFile`
-
+-- | Generate an image file from from the state content of an EC
+-- computation. The state may have any type that is an instance of
+-- `ToRenderable`
 toFile :: (Default r,ToRenderable r) => FileOptions -> FilePath -> EC r () -> IO ()
 toFile fo path ec = void $ renderableToFile fo path (toRenderable (execEC ec))