Add deprecated message for conversions number to interval (#98)

* add deprecated message for conversion number to interval

* add TODO comment for the next breaking release

* Update depwarn message

Co-authored-by: Tim Holy <[email protected]>

* update depwarn comments suggested by @timholy

Co-authored-by: Tim Holy <[email protected]>

Author: hyrodium

src/IntervalSets.jl

@@ -250,15 +250,31 @@ end
 include("interval.jl")
 
 # convert numbers to intervals
-convert(::Type{AbstractInterval}, x::Number) = x..x
-convert(::Type{AbstractInterval{T}}, x::Number) where T =
+# TODO: These conversions will be removed in the next breaking release (#97)
+function convert(::Type{AbstractInterval}, x::Number)
+    Base.depwarn("`The conversion number to interval will be removed; construct an interval explicitly, e.g., `x..x`.", :convert)
+    x..x
+end
+function convert(::Type{AbstractInterval{T}}, x::Number) where T
+    Base.depwarn("`The conversion number to interval will be removed; construct an interval explicitly, e.g., `x..x`.", :convert)
     convert(AbstractInterval{T}, convert(AbstractInterval, x))
-convert(::Type{TypedEndpointsInterval{:closed,:closed}}, x::Number) = x..x
-convert(::Type{TypedEndpointsInterval{:closed,:closed,T}}, x::Number) where T =
+end
+function convert(::Type{TypedEndpointsInterval{:closed,:closed}}, x::Number)
+    Base.depwarn("`The conversion number to interval will be removed; construct an interval explicitly, e.g., `x..x`.", :convert)
+    x..x
+end
+function convert(::Type{TypedEndpointsInterval{:closed,:closed,T}}, x::Number) where T
+    Base.depwarn("`The conversion number to interval will be removed; construct an interval explicitly, e.g., `x..x`.", :convert)
     convert(AbstractInterval{T}, convert(AbstractInterval, x))
-convert(::Type{ClosedInterval}, x::Number) = x..x
-convert(::Type{ClosedInterval{T}}, x::Number) where T =
+end
+function convert(::Type{ClosedInterval}, x::Number)
+    Base.depwarn("`The conversion number to interval will be removed; construct an interval explicitly, e.g., `x..x`.", :convert)
+    x..x
+end
+function convert(::Type{ClosedInterval{T}}, x::Number) where T
+    Base.depwarn("`The conversion number to interval will be removed; construct an interval explicitly, e.g., `x..x`.", :convert)
     convert(AbstractInterval{T}, convert(AbstractInterval, x))
+end
 
 include("findall.jl")
 

test/runtests.jl

@@ -211,6 +211,7 @@ struct IncompleteInterval <: AbstractInterval{Int} end
         @test 1.0..2.0 === 1.0..2 === 1..2.0 === ClosedInterval{Float64}(1..2) ===
                 Interval(1.0,2.0)
 
+        # TODO: Remove this test in the next breaking release (#97)
         @test convert(AbstractInterval, 1.0) ==
                 convert(AbstractInterval{Float64}, 1) ==
                 convert(TypedEndpointsInterval{:closed,:closed}, 1.0) ==