From 0a1f36802bfce800c4c7677ed126ff1e32f3506a Mon Sep 17 00:00:00 2001
From: Ben Orchard <thefirstmuffinman@gmail.com>
Date: Sat, 12 Oct 2024 02:47:51 +0100
Subject: [PATCH] Simplify: tweak a docstring

---
 src/Rerefined/Simplify.hs | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/Rerefined/Simplify.hs b/src/Rerefined/Simplify.hs
index 5d6d22f..002b93e 100644
--- a/src/Rerefined/Simplify.hs
+++ b/src/Rerefined/Simplify.hs
@@ -52,11 +52,13 @@ type family TrySimplifyLoop p mp where
     -- couldn't simplify
     TrySimplifyLoop p Nothing   = Nothing
 
-type AssertSimplified p = AssertSimplified' p (TrySimplify p)
-
 -- | Assert that a predicate may not be trivially simplified.
 --
 -- Returns the empty constraint on success, else emits a pretty type error.
+--
+-- Useful e.g. if you'd like to make sure a user isn't writing silly predicates.
+type AssertSimplified p = AssertSimplified' p (TrySimplify p)
+
 type family AssertSimplified' p mp' :: Constraint where
     AssertSimplified' p Nothing   = ()
     AssertSimplified' p (Just p') = TypeError