test: use ReferenceTests

Author: ReubenJ

Project.toml

@@ -9,8 +9,9 @@ julia = "1"
 LibGit2 = "76f85450-5226-5b5a-8eaa-529ad045b433"
 Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+ReferenceTests = "324d217c-45ce-50fc-942e-d289b448e8cf"
 REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["LibGit2", "Markdown", "Pkg", "REPL", "Test"]
+test = ["LibGit2", "Markdown", "Pkg", "REPL", "ReferenceTests", "Test"]

src/abbreviations.jl

@@ -365,8 +365,8 @@ const TYPEDSIGNATURES = TypedMethodSignatures(true)
 """
 An alternative to [`TYPEDSIGNATURES`](@ref) that omits the return type.
 
-The return type shown by [`TYPEDSIGNATURES`](@ref) is often `-> Any`, which is usually not
-correct. It is nicer to then just omit the type completely.
+The return type shown by [`TYPEDSIGNATURES`](@ref) is often `-> Any`, which is often not
+informative. It is nicer to then just omit the type completely.
 """
 const TYPEDSIGNATURESNORETURN = TypedMethodSignatures(false)
 

test/references/typed_no_return/g_2.txt

@@ -0,0 +1,6 @@
+
+```julia
+g_2(x::String)
+
+```
+

test/references/typed_no_return/h_1.txt

@@ -0,0 +1,6 @@
+
+```julia
+h_1(x::Union{Array{T, 3}, Array{T, 4}} where T)
+
+```
+

test/references/typed_no_return/h_int.txt

@@ -0,0 +1,6 @@
+
+```julia
+h(x::Int64; ...)
+
+```
+

test/references/typed_no_return/h_int_int_int.txt

@@ -0,0 +1,6 @@
+
+```julia
+h(x::Int64, y::Int64, z::Int64; kwargs...)
+
+```
+

test/runtests.jl

@@ -3,5 +3,6 @@ using Test
 import Markdown
 import LibGit2
 import REPL
+import ReferenceTests: @test_reference
 
 include("tests.jl")

test/tests.jl

@@ -463,17 +463,7 @@ end
             )
             DSE.format(DSE.TYPEDSIGNATURESNORETURN, buf, doc)
             str = String(take!(buf))
-            @test occursin("\n```julia\n", str)
-            f = str -> replace(str, " " => "")
-            str = f(str)
-            if Sys.iswindows() && VERSION < v"1.8"
-                @test occursin(f("h_1(x::Union{Array{T,4}, Array{T,3}} where T)"), str)
-            else
-                @test occursin(f("h_1(x::Union{Array{T,3}, Array{T,4}} where T)"), str)
-            end
-            @test !occursin("->", str)
-            @test occursin("\n```\n", str)
-
+            @test_reference "references/typed_no_return/h_1.txt" str
 
             doc.data = Dict(
                 :binding => Docs.Binding(M, :g_2),
@@ -482,9 +472,7 @@ end
             )
             DSE.format(TYPEDSIGNATURESNORETURN, buf, doc)
             str = String(take!(buf))
-            @test occursin("\n```julia\n", str)
-            @test occursin("\ng_2(x::String)", str)
-            @test occursin("\n```\n", str)
+            @test_reference "references/typed_no_return/g_2.txt" str
 
             doc.data = Dict(
                 :binding => Docs.Binding(M, :h),
@@ -493,13 +481,7 @@ end
             )
             DSE.format(DSE.TYPEDSIGNATURESNORETURN, buf, doc)
             str = String(take!(buf))
-            @test occursin("\n```julia\n", str)
-            if typeof(1) === Int64
-                @test occursin("\nh(x::Int64, y::Int64, z::Int64; kwargs...)\n", str)
-            else
-                @test occursin("\nh(x::Int32, y::Int32, z::Int32; kwargs...)\n", str)
-            end
-            @test occursin("\n```\n", str)
+            @test_reference "references/typed_no_return/h_int_int_int.txt" str
 
             doc.data = Dict(
                 :binding => Docs.Binding(M, :h),
@@ -508,26 +490,7 @@ end
             )
             DSE.format(DSE.TYPEDSIGNATURESNORETURN, buf, doc)
             str = String(take!(buf))
-            @test occursin("\n```julia\n", str)
-            if typeof(1) === Int64
-                # On 1.10+, automatically generated methods have keywords in the metadata,
-                # hence the display difference between Julia versions.
-                if VERSION >= v"1.10"
-                    @test occursin("\nh(x::Int64; ...)\n", str)
-                else
-                    @test occursin("\nh(x::Int64)\n", str)
-                end
-            else
-                # On 1.10+, automatically generated methods have keywords in the metadata,
-                # hence the display difference between Julia versions.
-                if VERSION >= v"1.10"
-                    @test occursin("\nh(x::Int32; ...)\n", str)
-                else
-                    @test occursin("\nh(x::Int32)\n", str)
-                end
-            end
-            @test occursin("\n```\n", str)
-
+            @test_reference "references/typed_no_return/h_int.txt" str
         end
 
         @testset "function names" begin