RotView: haddock updates

darcs-hash:20071127185741-bd4d7-440e0485cba3e32a171954ada89a1ad2df4eaaad.gz

1 files changed, 12 insertions, 7 deletions

diff --git a/XMonad/Actions/RotView.hs b/XMonad/Actions/RotView.hs
index 6d4f8ea..794d717 100644
--- a/XMonad/Actions/RotView.hs
+++ b/XMonad/Actions/RotView.hs
@@ -28,17 +28,22 @@ import XMonad.StackSet hiding (filter)
 import XMonad.Operations
 
 -- $usage
--- You can use this module with the following in your Config.hs file:
+--
+-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
 --
 -- > import XMonad.Actions.RotView
 --
--- >   , ((modMask .|. shiftMask, xK_Right), rotView True)
--- >   , ((modMask .|. shiftMask, xK_Left), rotView False)
-
--- %import XMonad.Actions.RotView
--- %keybind , ((modMask .|. shiftMask, xK_Right), rotView True)
--- %keybind , ((modMask .|. shiftMask, xK_Left), rotView False)
+-- Then add appropriate key bindings, such as:
+--
+-- >   , ((modMask x .|. shiftMask, xK_Right), rotView True)
+-- >   , ((modMask x .|. shiftMask, xK_Left), rotView False)
+--
+-- For detailed instructions on editing your key bindings, see
+-- "XMonad.Doc.Extending#Editing_key_bindings".
 
+-- | Cycle through non-empty workspaces.  True --> cycle in the forward
+--   direction.  Note that workspaces cycle in order by tag, so if your
+--   workspaces are not in tag-order, the cycling might seem wonky.
 rotView :: Bool -> X ()
 rotView forward = do
     ws <- gets windowset