Deprecate X.L.Circle module in favour of X.L.CircleEx.

xmonad · Dec 17, 2023 · e23fa48 · e23fa48
1 parent 0d1784d
commit e23fa48
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/XMonad/Layout/Circle.hs b/XMonad/Layout/Circle.hs
@@ -15,11 +15,11 @@
 --
 -----------------------------------------------------------------------------
 
-module XMonad.Layout.Circle (
-                             -- * Usage
-                             -- $usage
-                             Circle (..)
-                            ) where -- actually it's an ellipse
+module XMonad.Layout.Circle {-# DEPRECATED "Use XMonad.Layout.CircleEx instead" #-}
+  ( -- * Usage
+    -- $usage
+    Circle (..)
+  ) where -- actually it's an ellipse
 
 import XMonad.Prelude
 import XMonad

diff --git a/XMonad/Layout/CircleEx.hs b/XMonad/Layout/CircleEx.hs
@@ -88,12 +88,12 @@ data CircleEx a = CircleEx {
 -- | Circle layout with default settings:
 --
 -- * Number of master windows is set to 1
--- * @cMasterRatio@ is set to @70/99@, which is nearly sqrt(2)
+-- * @cMasterRatio@ is set to @70/99@, which is nearly @1/sqrt(2)@
 -- * @cSlaveRatio@ is set to @2/5@
 -- * @cMultiplier@ is set to 1, which means all slave windows
 --   will have the same size
 --
--- This can be used as a drop-in replacement for "XMonad.Layout.Circle.Circle".
+-- This can be used as a drop-in replacement for "XMonad.Layout.Circle".
 circle :: CircleEx a
 circle = CircleEx 1 (70%99) (2%5) 1 0