Fix Vararg printing (#113)

Author: Rogerluo

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
       matrix:
         version:
           - '1.0'
-          - '1.5'
+          - '1'
           - 'nightly'
         os:
           - ubuntu-latest
@@ -48,7 +48,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
         with:
-          version: '1.5'
+          version: '1.6'
       - run: |
           julia --project=docs -e '
             using Pkg

.gitignore

@@ -5,3 +5,4 @@ docs/build
 docs/site
 docs/Manifest.toml
 Manifest.toml
+.vscode

README.md

@@ -4,7 +4,7 @@
 
 | **Documentation**                                                               | **Build Status**                                                                                |
 |:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|
-| [![][docs-stable-img]][docs-stable-url] [![][docs-latest-img]][docs-latest-url] | [![][travis-img]][travis-url] [![][appveyor-img]][appveyor-url] [![][codecov-img]][codecov-url] |
+| [![][docs-stable-img]][docs-stable-url] [![][docs-latest-img]][docs-latest-url] | [![CI][github-action-img]][github-action-url] [![][codecov-img]][codecov-url] |
 
 ## Installation
 
@@ -37,6 +37,9 @@ Contributions are very welcome, as are feature requests and suggestions. Please
 [docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
 [docs-stable-url]: https://juliadocs.github.io/DocStringExtensions.jl/stable
 
+[github-action-img]: https://github.com/JuliaDocs/DocStringExtensions.jl/actions/workflows/ci.yml/badge.svg
+[github-action-url]: https://github.com/JuliaDocs/DocStringExtensions.jl/actions/workflows/ci.yml
+
 [travis-img]: https://travis-ci.org/JuliaDocs/DocStringExtensions.jl.svg?branch=master
 [travis-url]: https://travis-ci.org/JuliaDocs/DocStringExtensions.jl
 

src/DocStringExtensions.jl

@@ -1,5 +1,3 @@
-__precompile__(true)
-
 """
 *Extensions for the Julia docsystem.*
 

src/abbreviations.jl

@@ -320,6 +320,7 @@ function format(::MethodSignatures, buf, doc)
     local modname = doc.data[:module]
     local func = Docs.resolve(binding)
     local groups = methodgroups(func, typesig, modname)
+
     if !isempty(groups)
         println(buf)
         println(buf, "```julia")
@@ -518,10 +519,6 @@ function print_mutable_struct_or_struct(buf, object)
     println(buf)
 end
 
-@static if VERSION < v"0.7.0"
-    isprimitivetype(x) = isbitstype(x)
-end
-
 function format(::TypeDefinition, buf, doc)
     local binding = doc.data[:binding]
     local object = gettype(Docs.resolve(binding))

src/templates.jl

@@ -65,12 +65,7 @@ template for modules found in module `ModName`.
 
 """
 macro template(ex)
-    # JuliaLang/julia#22064 introduced the __module__ variable and deprecated current_module()
-    @static if VERSION >= v"0.7.0-DEV.484"
-        template(__source__, __module__, ex)
-    else
-        template(LineNumberNode(0), current_module(), ex)
-    end
+    template(__source__, __module__, ex)
 end
 
 const TEMP_SYM = gensym("templates")

src/utilities.jl

@@ -292,9 +292,23 @@ function printmethod(buffer::IOBuffer, binding::Docs.Binding, func, method::Meth
     print(buffer, "(")
     local args = arguments(method)
     local where_syntax = []
+
     for (i, sym) in enumerate(args)
         t = typesig.types[i]
-        print(buffer, "$sym::$t")
+        if isvarargtype(t)
+            elt = vararg_eltype(t)
+
+            if elt === Any
+                print(buffer, "$sym...")
+            else
+                print(buffer, "$sym::$elt...")
+            end
+        elseif t === Any
+            print(buffer, sym)
+        else
+            print(buffer, "$sym::$t")
+        end
+
         if i != length(args)
             print(buffer, ", ")
         end
@@ -317,6 +331,35 @@ printmethod(b, f, m) = String(take!(printmethod(IOBuffer(), b, f, m)))
 get_method_source(m::Method) = Base.uncompressed_ast(m)
 nargs(m::Method) = m.nargs
 
+function isvarargtype(t)
+    @static if VERSION > v"1.7-"
+        t isa Core.TypeofVararg
+    elseif VERSION > v"1.5-"
+        t isa Type && t <: Vararg
+    else
+        # don't special print Vararg
+        # below 1.5
+        false
+    end
+end
+
+function vararg_eltype(t)
+    @static if VERSION > v"1.7-"
+        return t.T
+    elseif VERSION > v"1.5-"
+        if t isa DataType
+            return t.parameters[1]
+        elseif t isa UnionAll
+            return t.body.parameters[1]
+        else
+            # don't know how to handle
+            # just return Any
+            return Any
+        end
+    else
+        error("cannot handle Vararg below 1.5")
+    end
+end
 
 """
 $(:SIGNATURES)

test/TestModule/M.jl

@@ -33,6 +33,8 @@ k_7(x::Union{T,Nothing}, y::T = zero(T)) where {T <: Integer} = x
 k_8(x) = x
 k_9(x::T where T<:Any) = x
 k_10(x::T) where T = x
+k_11(x::Int, xs...) = x
+k_12(x::Int, xs::Real...) = x
 
 mutable struct T
     a

test/tests.jl

@@ -259,7 +259,7 @@ end
             DSE.format(DSE.TYPEDSIGNATURES, buf, doc)
             str = String(take!(buf))
             @test occursin("\n```julia\n", str)
-            @test occursin("\nk_3(x::Any, y::T, z::U) -> Any\n", str)
+            @test occursin("\nk_3(x, y::T, z::U) -> Any\n", str)
             @test occursin("\n```\n", str)
 
             doc.data = Dict(
@@ -338,7 +338,7 @@ end
             DSE.format(DSE.TYPEDSIGNATURES, buf, doc)
             str = String(take!(buf))
             @test occursin("\n```julia\n", str)
-            @test occursin("\nk_8(x::Any) -> Any\n", str)
+            @test occursin("\nk_8(x) -> Any\n", str)
             @test occursin("\n```\n", str)
 
             doc.data = Dict(
@@ -349,9 +349,35 @@ end
             DSE.format(DSE.TYPEDSIGNATURES, buf, doc)
             str = String(take!(buf))
             @test occursin("\n```julia\n", str)
-            @test occursin("\nk_9(x::Any) -> Any\n", str)
+            @test occursin("\nk_9(x) -> Any\n", str)
             @test occursin("\n```\n", str)
 
+            @static if VERSION > v"1.5-" # see JuliaLang/#40405
+
+                doc.data = Dict(
+                    :binding => Docs.Binding(M, :k_11),
+                    :typesig => Union{Tuple{Int, Vararg{Any}}},
+                    :module => M,
+                )
+                DSE.format(DSE.TYPEDSIGNATURES, buf, doc)
+                str = String(take!(buf))
+                @test occursin("\n```julia\n", str)
+                @test occursin("\nk_11(x::Int64, xs...) -> Int64\n", str)
+                @test occursin("\n```\n", str)
+
+                doc.data = Dict(
+                    :binding => Docs.Binding(M, :k_12),
+                    :typesig => Union{Tuple{Int, Vararg{Real}}},
+                    :module => M,
+                )
+                DSE.format(DSE.TYPEDSIGNATURES, buf, doc)
+                str = String(take!(buf))
+                @test occursin("\n```julia\n", str)
+                @test occursin("\nk_12(x::Int64, xs::Real...) -> Int64\n", str)
+                @test occursin("\n```\n", str)
+
+            end
+
             doc.data = Dict(
                 :binding => Docs.Binding(M, :k_10),
                 :typesig => Union{Tuple{T}, Tuple{T}} where T,