Deprecate old TH functions according to plan

tomjaguarpaw · Apr 17, 2023 · 0b991d5 · 0b991d5
1 parent 01ee72d
commit 0b991d5
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+# Unreleased (major)
+
+* `Data.Profunctor.Product.TH.makeAdaptorAndInstance` is deprecated in
+  favor of `makeAdaptorAndInstanceInferrable`
+* `Data.Profunctor.Product.TH.makeAdaptorAndInstance'` is deprecated in
+  favor of `makeAdaptorAndInstanceInferrable'`
+
 # 0.11.1.1
 
 * No user-visible changes

diff --git a/Data/Profunctor/Product/TH.hs b/Data/Profunctor/Product/TH.hs
@@ -148,15 +148,15 @@ makeAdaptorAndInstanceInferrable' =
   makeAdaptorAndInstanceI True Nothing
 
 -- | Use 'makeAdaptorAndInstanceInferrable' instead, because it
--- generates instances with better inference properties.  Will be
--- deprecated in version 0.12.
+-- generates instances with better inference properties.
 makeAdaptorAndInstance :: String -> TH.Name -> TH.Q [TH.Dec]
 makeAdaptorAndInstance adaptorNameS =
   makeAdaptorAndInstanceI False (Just adaptorNameS)
+{-# DEPRECATED makeAdaptorAndInstance "Use makeAdaptorAndInstanceInferrable instead" #-}
 
 -- | Use 'makeAdaptorAndInstanceInferrable' instead, because it
--- generates instances with better inference properties.  Will be
--- deprecated in version 0.12.
+-- generates instances with better inference properties.
 makeAdaptorAndInstance' :: TH.Name -> TH.Q [TH.Dec]
 makeAdaptorAndInstance' =
   makeAdaptorAndInstanceI False Nothing
+{-# DEPRECATED makeAdaptorAndInstance' "Use makeAdaptorAndInstanceInferrable' instead" #-}