SwapWorkspaces: haddock updates

darcs-hash:20071127192634-bd4d7-e08eecebd6236e7ed586decac443a68ec9e5a912.gz

1 files changed, 7 insertions, 8 deletions

diff --git a/XMonad/Actions/SwapWorkspaces.hs b/XMonad/Actions/SwapWorkspaces.hs
index 3f0ca35..e4284bf 100644
--- a/XMonad/Actions/SwapWorkspaces.hs
+++ b/XMonad/Actions/SwapWorkspaces.hs
@@ -22,24 +22,23 @@ module XMonad.Actions.SwapWorkspaces (
 
 import XMonad.StackSet
 
+
 -- $usage
--- Add this import to your Config.hs:
+-- Add this import to your @~\/.xmonad\/xmonad.hs@:
 --
 -- > import XMonad.Actions.SwapWorkspaces
 --
--- Throw this in your keys definition:
+-- Then throw something like this in your keys definition:
 --
 -- > ++
--- > [((modMask .|. controlMask, k), windows $ swapWithCurrent i)
+-- > [((modMask x .|. controlMask, k), windows $ swapWithCurrent i)
 -- >     | (i, k) <- zip workspaces [xK_1 ..]]
-
--- %import XMonad.Actions.SwapWorkspaces
--- %keybindlist ++
--- %keybindlist [((modMask .|. controlMask, k), windows $ swapWithCurrent i)
--- %keybindlist     | (i, k) <- zip workspaces [xK_1 ..]]
 --
 -- After installing this update, if you're on workspace 1, hitting mod-ctrl-5
 -- will swap workspaces 1 and 5.
+--
+-- For detailed instructions on editing your key bindings, see
+-- "XMonad.Doc.Extending#Editing_key_bindings".
 
 -- | Swaps the currently focused workspace with the given workspace tag, via
 --   @swapWorkspaces@.