SinkAll: haddock updates

darcs-hash:20071127191318-bd4d7-2974e5444a22be42c418260f8beffd733a01b1e3.gz

1 files changed, 12 insertions, 8 deletions

diff --git a/XMonad/Actions/SinkAll.hs b/XMonad/Actions/SinkAll.hs
index 87cb206..e5eee4b 100644
--- a/XMonad/Actions/SinkAll.hs
+++ b/XMonad/Actions/SinkAll.hs
@@ -15,24 +15,28 @@ module XMonad.Actions.SinkAll (
     sinkAll) where
 
 import XMonad.Operations
-import XMonad
+import XMonad.Core
 import XMonad.StackSet
 
 import Graphics.X11.Xlib
-
 -- $usage
+--
+-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
+--
 -- > import XMonad.Actions.SinkAll
--- > keys x = [ ((modMask x .|. shiftMask, xK_t), sinkAll) ]
 --
--- where 'x' is your XConfig.
-
--- %import XMonad.Actions.SinkAll
--- %keybind , ((modMask x .|. shiftMask, xK_t), sinkAll)
+-- then add a keybinding; for example:
+--
+--     , ((modMask x .|. shiftMask, xK_t), sinkAll)
+--
+-- For detailed instructions on editing your key bindings, see
+-- "XMonad.Doc.Extending#Editing_key_bindings".
 
+-- | Un-float all floating windows on the current workspace.
 sinkAll :: X ()
 sinkAll = withAll sink
 
--- Apply a function to all windows on current workspace.
+-- | Apply a function to all windows on current workspace.
 withAll :: (Window -> WindowSet -> WindowSet) -> X ()
 withAll f = windows $ \ws -> let all' = integrate' . stack . workspace . current $ ws
                              in foldr f ws all'