StackSet.hs: (new): better comment; 'm' is not an integer, it is a list of screen descriptions.

darcs-hash:20071022183411-bd4d7-00a0550d101435adca2d6e38a78f49e353a8aa3e

1 files changed, 5 insertions, 3 deletions

diff --git a/StackSet.hs b/StackSet.hs
index f607764..654ff5d 100644
--- a/StackSet.hs
+++ b/StackSet.hs
@@ -208,9 +208,11 @@ abort x = error $ "xmonad: StackSet: " ++ x
 -- ---------------------------------------------------------------------
 -- $construction
 
--- | /O(n)/. Create a new stackset, of empty stacks, with given tags, with
--- 'm' physical screens. 'm' should be less than or equal to the number of
--- workspace tags.  The first workspace in the list will be current.
+-- | /O(n)/. Create a new stackset, of empty stacks, with given tags,
+-- with physical screens whose descriptions are given by 'm'. The
+-- number of physical screens (@length 'm'@) should be less than or
+-- equal to the number of workspace tags.  The first workspace in the
+-- list will be current.
 --
 -- Xinerama: Virtual workspaces are assigned to physical screens, starting at 0.
 --