fix comment, formatting

src/Swarm/TUI/View/Attribute/Attr.hs

@@ -49,20 +49,20 @@ module Swarm.TUI.View.Attribute.Attr (
   customEditFocusedAttr,
 ) where
 
-import Data.List.NonEmpty (NonEmpty (..))
-import Data.List.NonEmpty qualified as NE
 import Brick
 import Brick.Forms
 import Brick.Widgets.Dialog
 import Brick.Widgets.Edit qualified as E
 import Brick.Widgets.List hiding (reverse)
 import Data.Bifunctor (bimap)
 import Data.Colour.Palette.BrewerSet
+import Data.List.NonEmpty (NonEmpty (..))
+import Data.List.NonEmpty qualified as NE
+import Data.Maybe (fromMaybe)
 import Data.Text (unpack)
 import Graphics.Vty qualified as V
 import Swarm.Game.Display (Attribute (..))
 import Swarm.TUI.View.Attribute.Util
-import Data.Maybe (fromMaybe)
 
 toAttrName :: Attribute -> AttrName
 toAttrName = \case
@@ -149,9 +149,9 @@ activityMeterPrefix = attrName "activityMeter"
 
 activityMeterAttributes :: NonEmpty (AttrName, V.Attr)
 activityMeterAttributes =
-   NE.zip indices $ fromMaybe (pure $ bg V.black) $ NE.nonEmpty brewers
+  NE.zip indices $ fromMaybe (pure $ bg V.black) $ NE.nonEmpty brewers
  where
-  indices = NE.map ((activityMeterPrefix <>) . attrName . show) $ (0 :: Int) :| [1..]
+  indices = NE.map ((activityMeterPrefix <>) . attrName . show) $ (0 :: Int) :| [1 ..]
   brewers = map bgWithAutoForeground $ reverse $ brewerSet RdYlGn 7
 
 meterAttributeNames :: NonEmpty AttrName

src/Swarm/Util/UnitInterval.hs

@@ -9,8 +9,8 @@ module Swarm.Util.UnitInterval (
   safeIndex,
 ) where
 
-import Prelude hiding ((!!))
 import Data.List.NonEmpty (NonEmpty, (!!))
+import Prelude hiding ((!!))
 
 newtype UnitInterval a = UnitInterval
   { getValue :: a
@@ -23,14 +23,16 @@ mkInterval :: (Ord a, Num a) => a -> UnitInterval a
 mkInterval = UnitInterval . max 0 . min 1
 
 -- | Since '(!!)' is partial, here is "proof" that it is safe:
--- If 'dutyCycleRatio' is 1, then the maximum value of 'dutyCycleAttrIdx' is
---    --   one less than the length of 'meterAttributeNames' (i.e., a valid index).
+-- If "alpha" is its maximum value of @1@, then the maximum value
+-- of the computed index shall be one less than the length of the
+-- list (i.e., a valid index).
 --
 -- See also: 'Swarm.Util.indexWrapNonEmpty'.
-safeIndex :: RealFrac a =>
+safeIndex ::
+  RealFrac a =>
   -- | alpha
   UnitInterval a ->
-    NonEmpty b ->
-      b
+  NonEmpty b ->
+  b
 safeIndex (UnitInterval alpha) xs =
   xs !! floor (alpha * fromIntegral (length xs - 1))