Add documentation to Dishes.hs

darcs-hash:20071012072953-25eb7-df0c646cdc908f54c60943cc7d5441591073f7d2.gz

1 files changed, 6 insertions, 1 deletions

diff --git a/Dishes.hs b/Dishes.hs
index cb09d9d..a7ace7d 100644
--- a/Dishes.hs
+++ b/Dishes.hs
@@ -32,15 +32,20 @@ import Graphics.X11.Xlib
 -- You can use this module with the following in your Config.hs file:
 --
 -- > import XMonadContrib.Dishes
+--
+-- and add the following line to your 'defaultLayouts'
+--
+-- > , Layout $ Dishes 2 (1%6)
 
 -- %import XMonadContrib.Dishes
+-- %layout , Layout $ Dishes 2 (1%6)
 
 data Dishes a = Dishes Int Rational deriving (Show, Read)
 instance LayoutClass Dishes a where
 	doLayout (Dishes nmaster h) r =
 		return . (\x->(x,Nothing)) .
 		ap zip (dishes h r nmaster . length) . integrate
-	handleMessage (Dishes nmaster h) m = return $ fmap incmastern (fromMessage m)
+	pureMessage (Dishes nmaster h) m = fmap incmastern (fromMessage m)
 		where incmastern (IncMasterN d) = Dishes (max 0 (nmaster+d)) h
 
 dishes :: Rational -> Rectangle -> Int -> Int -> [Rectangle]