document that avoidStruts must be applied before any modifier that

changes the screen rectangle
This commit is contained in:
brandon s allbery kf8nh
2021-12-22 16:27:21 -05:00
parent 0010735aca
commit a67be39673

View File

@@ -216,12 +216,18 @@ calcGap ss = do
-- | Adjust layout automagically: don't cover up any docks, status
-- bars, etc.
--
-- Note that this modifier must be applied before any modifier that
-- changes the screen rectangle, or struts will be applied in the wrong
-- place and may affect the other modifier(s) in odd ways. This is
-- most commonly seen with the 'spacing' modifier and friends.
avoidStruts :: LayoutClass l a => l a -> ModifiedLayout AvoidStruts l a
avoidStruts = avoidStrutsOn [U,D,L,R]
-- | Adjust layout automagically: don't cover up docks, status bars,
-- etc. on the indicated sides of the screen. Valid sides are U
-- (top), D (bottom), R (right), or L (left).
-- etc. on the indicated sides of the screen. Valid sides are 'U'
-- (top), 'D' (bottom), 'R' (right), or 'L' (left). The warning in
-- 'avoidStruts' applies to this modifier as well.
avoidStrutsOn :: LayoutClass l a =>
[Direction2D]
-> l a