From e964189b9f76302fff82685df3d65ea279979f92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20B=C3=A4renz?= Date: Tue, 20 Dec 2022 13:49:07 +0100 Subject: [PATCH] Improve haddocks --- src/Data/Monoid/Action.hs | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/Data/Monoid/Action.hs b/src/Data/Monoid/Action.hs index ebbd5bf..ad62006 100644 --- a/src/Data/Monoid/Action.hs +++ b/src/Data/Monoid/Action.hs @@ -100,15 +100,16 @@ instance Fractional a => Action Rational (Product a) where -- | An action of a group is "free transitive", "regular", or a "torsor" -- iff it is invertible. -- --- Given a value `s2` that has been acted upon by `m`, --- and the original value `s1`, it is possible to recover the acting `m`. +-- Given an original value `sOrig`, and a value `sActed` that is the result +-- of acting on `sOrig` by some `m`, +-- it is possible to recover this `m`. -- This is encoded in the laws: -- -- * @(m `'act'` s) `'difference'` s = m@ --- * @(s1 `'difference'` s2) `'act'` s2 = s1@ +-- * @(sActed `'difference'` sOrig) `'act'` sOrig = sActed@ class Group m => Torsor m s where - -- | @'difference' s1 s2@ is the element @m@ such that @s1 = m `'act'` s2@. + -- | @'difference' sActed sOrig@ is the element @m@ such that @sActed = m `'act'` sOrig@. difference :: s -> s -> m -- | Any monoid acts on itself by left multiplication.