XMonad.Util.Themes: improve documentation to make it clear that themes only apply to decorated layouts

darcs-hash:20080324185946-bd4d7-477aaac8b62e875914f56ff7cd8ea7dbfbf58500.gz

1 files changed, 12 insertions, 8 deletions

diff --git a/XMonad/Util/Themes.hs b/XMonad/Util/Themes.hs
index 46bd8de..b845403 100644
--- a/XMonad/Util/Themes.hs
+++ b/XMonad/Util/Themes.hs
@@ -8,7 +8,7 @@
 -- Stability   :  unstable
 -- Portability :  unportable
 --
--- A (hopefully) growing collection of themes for xmonad
+-- A (hopefully) growing collection of themes for decorated layouts.
 --
 -----------------------------------------------------------------------------
 
@@ -30,13 +30,17 @@ module XMonad.Util.Themes
 import XMonad.Layout.Decoration
 
 -- $usage
--- This module stores some user contributed themes.
+-- This module stores some user contributed themes which can be used
+-- with decorated layouts (such as Tabbed).  (Note that these themes
+-- only apply to decorated layouts, such as those found in
+-- "XMonad.Layout.Tabbed" and "XMonad.Layout.DecorationMadness"; they
+-- do not apply to xmonad as a whole.)
 --
--- If you want to use one of this them as your default theme for one
--- of your layouts, you need to substitute defaultTheme with, for
--- instance, (theme smallClean).
+-- If you want to use one of them with one of your decorated layouts,
+-- you need to substitute defaultTheme with, for instance, (theme
+-- smallClean).
 --
--- This is an example:
+-- Here is an example:
 --
 -- > import XMonad
 -- > import XMonad.Util.Themes
@@ -111,12 +115,12 @@ smallClean =
                                                }
              }
 
--- | Don's prefered colors - fomr DynamicLog...;)
+-- | Don's prefered colors - from DynamicLog...;)
 donaldTheme  :: ThemeInfo
 donaldTheme =
     newTheme { themeName        = "donaldTheme"
              , themeAuthor      = "Andrea Rossato"
-             , themeDescription = "Don's prefered colors - fomr DynamicLog...;)"
+             , themeDescription = "Don's prefered colors - from DynamicLog...;)"
              , theme            = defaultTheme { activeColor         = "#2b4f98"
                                                , inactiveColor       = "#cccccc"
                                                , activeBorderColor   = "#2b4f98"