Add warning about deprecation of adjoint syntax (#112)

JuliaDynamics · Oct 17, 2024 · 29a2e0a · 29a2e0a
1 parent 00a8be0
commit 29a2e0a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 7 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "LightSumTypes"
 uuid = "f56206fc-af4c-5561-a72a-43fe2ca5a923"
-version = "4.1.0"
+version = "4.2.0"
 
 [deps]
 ExprTools = "e2ba6199-217a-4e67-a87a-7c52f15ade04"

diff --git a/src/LightSumTypes.jl b/src/LightSumTypes.jl
@@ -65,9 +65,13 @@ function sumtype_expr(typedef)
 
     constructors = [:(@inline $(namify(type))(v::Union{$(variants...)}) where {$(typeparams...)} = 
                         $(branchs(variants, variants_with_P, :(return new{$(typeparams...)}(v)))...))]
-    constructors_extra = [:($Base.adjoint(SumT::Type{$typename}) = $(Expr(:tuple, (:($nv = (args...; kwargs...) -> 
-                                $LightSumTypes.constructor($typename, $v, args...; kwargs...)) for (nv, v) in 
-                                zip(variants_names, variants_bounded))...)))]
+    constructors_extra = [:(function $Base.adjoint(SumT::Type{$typename})
+                                @warn "Using A'.B syntax is deprecated in favour of the native A∘B syntax; \
+                                       the functionality will be removed in a future release of the package"
+                                return $(Expr(:tuple, (:($nv = (args...; kwargs...) -> 
+                                   $LightSumTypes.constructor($typename, $v, args...; kwargs...)) for (nv, v) in 
+                                   zip(variants_names, variants_bounded))...))
+                            end)]
 
     if type isa Expr
         push!(
@@ -77,9 +81,12 @@ function sumtype_expr(typedef)
         )
         push!(
             constructors_extra,
-            :($Base.adjoint(SumT::Type{$type}) where {$(typeparams...)} =
-                $(Expr(:tuple, (:($nv = (args...; kwargs...) -> $LightSumTypes.constructor($type, $v, args...; kwargs...)) 
-                        for (nv, v) in zip(variants_names, variants))...)))
+            :(function $Base.adjoint(SumT::Type{$type}) where {$(typeparams...)}
+                   @warn "Using A'.B syntax is deprecated in favour of the native A∘B syntax; \
+                          the functionality will be removed in a future release of the package"
+                   return $(Expr(:tuple, (:($nv = (args...; kwargs...) -> $LightSumTypes.constructor($type, $v, args...; kwargs...)) 
+                              for (nv, v) in zip(variants_names, variants))...))
+              end)
             )
     end