Describe parameters to subLayouts more

Ignore-this: d09f236cb17adf7a9092f1b0e646def3

darcs-hash:20091016164937-1499c-3efecfa342856feea67c3e7b97bc8a5b5be548fa.gz

1 files changed, 11 insertions, 5 deletions

diff --git a/XMonad/Layout/SubLayouts.hs b/XMonad/Layout/SubLayouts.hs
index 8aa0cd0..e769ef9 100644
--- a/XMonad/Layout/SubLayouts.hs
+++ b/XMonad/Layout/SubLayouts.hs
@@ -166,13 +166,19 @@ import Data.Map(Map)
 
 -- | The main layout modifier arguments:
 --
---  [@nextLayout@] When a new group is formed, use the layout @sl@ after
---  skipping that number of layouts. Specify a finite list and groups that do
---  not have a corresponding index get the first choice in @sls@
+-- @subLayout advanceInnerLayouts innerLayout outerLayout@
 --
---  [@sl@] The single layout given to be run as a sublayout.
+--  [@advanceInnerLayouts@] When a new group at index @n@ in the outer layout
+--  is created (even with one element), the @innerLayout@ is used as the
+--  layout within that group after being advanced with @advanceInnerLayouts !!
+--  n@ 'NextLayout' messages. If there is no corresponding element in the
+--  @advanceInnerLayouts@ list, then @innerLayout@ is not given any 'NextLayout'
+--  messages.
 --
---  [@x@] The layout that determines the rectangles that the groups get.
+--  [@innerLayout@] The single layout given to be run as a sublayout.
+--
+--  [@outerLayout@] The layout that determines the rectangles given to each
+--  group.
 --
 --  Ex. The second group is 'Tall', the third is 'Circle', all others are tabbed
 --  with: