X.L.NoBorders: Fix docs of data Ambiguity

In c6cdb77e3b, several new constructors
were added but not "In order of increasing ambiguity (less borders more
frequently)" as the docs for data Ambiguity say. Correct the order and
clarify that Never only considers ambiguity of tiled windows (as in the
doc for smartBorders).

Fixes: c6cdb77e3b ("'XMonad.Layout.NoBorders': various improvements:")
Related: https://github.com/xmonad/xmonad-contrib/issues/280
This commit is contained in:
Tomas Janousek
2021-01-01 23:12:54 +01:00
parent 081629d39f
commit a98cc194ad

View File

@@ -301,9 +301,6 @@ data Ambiguity
-- ^ This constructor is used to combine the borderless windows
-- provided by the SetsAmbiguous instances from two other 'Ambiguity'
-- data types.
| OnlyScreenFloat
-- ^ Only remove borders on floating windows that cover the whole
-- screen.
| OnlyLayoutFloatBelow
-- ^ Like 'OnlyLayoutFloat', but only removes borders if no window
-- stacked below remains visible. Considers all floating windows on the
@@ -314,9 +311,12 @@ data Ambiguity
| OnlyLayoutFloat
-- ^ Only remove borders on floating windows that exactly cover the
-- parent layout rectangle.
| OnlyScreenFloat
-- ^ Only remove borders on floating windows that cover the whole
-- screen.
| Never
-- ^ Never remove borders when ambiguous: this is the same as
-- smartBorders.
-- ^ Like 'OnlyScreenFloat', and also remove borders of tiled windows
-- when not ambiguous: this is the same as 'smartBorders'.
| EmptyScreen
-- ^ Focus in an empty screen does not count as ambiguous.
| OtherIndicated