Merge branch 'master' into fix/documenter_v1

Author: mortenpi

.github/workflows/ci.yml

@@ -6,11 +6,14 @@ on:
       - master
     tags:
       - '*'
+  schedule:
+    - cron: '0 0 * * 1' # runs 00:00 UTC on every Monday
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
     runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
         version:
           - '1.0'
@@ -23,13 +26,13 @@ jobs:
         arch:
           - x64
     steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v5
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
           show-versioninfo: true
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         env:
           cache-name: cache-artifacts
         with:
@@ -42,16 +45,16 @@ jobs:
       - uses: julia-actions/julia-runtest@latest
         continue-on-error: ${{ matrix.version == 'nightly' }}
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v5
         with:
           file: lcov.info
 
   docs:
     name: Documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v5
+      - uses: julia-actions/setup-julia@v2
         with:
           version: '1.6'
       - run: |

Project.toml

@@ -1,17 +1,16 @@
 name = "DocStringExtensions"
 uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
-version = "0.9.3"
-
-[deps]
-LibGit2 = "76f85450-5226-5b5a-8eaa-529ad045b433"
+version = "0.9.5"
 
 [compat]
 julia = "1"
 
 [extras]
+LibGit2 = "76f85450-5226-5b5a-8eaa-529ad045b433"
 Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Markdown", "Pkg", "Test"]
+test = ["LibGit2", "Markdown", "Pkg", "REPL", "Test"]

src/DocStringExtensions.jl

@@ -73,16 +73,12 @@ $(IMPORTS)
 """
 module DocStringExtensions
 
-# Imports.
-
-import LibGit2
-
 # Exports.
 
 export @template, FIELDS, TYPEDFIELDS, EXPORTS, METHODLIST, IMPORTS
 export SIGNATURES, TYPEDSIGNATURES, TYPEDEF, DOCSTRING, FUNCTIONNAME
 export README, LICENSE
-export interpolation
+# export interpolation
 
 # Includes.
 

src/utilities.jl

@@ -452,24 +452,28 @@ kws = keywords(f, first(methods(f)))
 ```
 """
 function keywords(func, m::Method)
-    table = methods(func).mt
-    # table is a MethodTable object. For some reason, the :kwsorter field is not always
-    # defined. An undefined kwsorter seems to imply that there are no methods in the
-    # MethodTable with keyword arguments.
-    if  !(Base.fieldindex(Core.MethodTable, :kwsorter, false) > 0) || isdefined(table, :kwsorter)
-        # Fetching method keywords stolen from base/replutil.jl:572-576 (commit 3b45cdc9aab0):
-        kwargs = VERSION < v"1.4.0-DEV.215" ? Base.kwarg_decl(m, typeof(table.kwsorter)) : Base.kwarg_decl(m)
-        if isa(kwargs, Vector) && length(kwargs) > 0
-            filter!(arg -> !occursin("#", string(arg)), kwargs)
-            # Keywords *may* not be sorted correctly. We move the vararg one to the end.
-            index = findfirst(arg -> endswith(string(arg), "..."), kwargs)
-            if index != nothing
-                kwargs[index], kwargs[end] = kwargs[end], kwargs[index]
-            end
-            return kwargs
+    kwargs = @static if VERSION < v"1.4.0-DEV.215"
+        table::Core.MethodTable = methods(func).mt
+        # For some reason, the :kwsorter field is not always defined.
+        # An undefined kwsorter seems to imply that there are no methods
+        # in the MethodTable with keyword arguments.
+        if Base.fieldindex(Core.MethodTable, :kwsorter, false) > 0 && !isdefined(table, :kwsorter)
+            return Symbol[]
         end
+        Base.kwarg_decl(m, typeof(table.kwsorter))
+    else
+        Base.kwarg_decl(m)
     end
-    return Symbol[]
+    if !isa(kwargs, Vector) || isempty(kwargs)
+        return Symbol[]
+    end
+    filter!(arg -> !occursin("#", string(arg)), kwargs)
+    # Keywords *may* not be sorted correctly. We move the vararg one to the end.
+    index = findfirst(arg -> endswith(string(arg), "..."), kwargs)
+    if index != nothing
+        kwargs[index], kwargs[end] = kwargs[end], kwargs[index]
+    end
+    return kwargs
 end
 
 
@@ -508,8 +512,6 @@ end
 #
 # Source URLs.
 #
-# Based on code from https://github.com/JuliaLang/julia/blob/master/base/methodshow.jl.
-#
 # Customised to handle URLs on travis since the directory is not a Git repo and we must
 # instead rely on `TRAVIS_REPO_SLUG` to get the remote repo.
 #
@@ -522,45 +524,26 @@ Get the URL (file and line number) where a method `m` is defined.
 Note that this is based on the implementation of `Base.url`, but handles URLs correctly
 on TravisCI as well.
 """
-url(m::Method) = url(m.module, string(m.file), m.line)
+function url(m::Method)
+    if haskey(ENV, "TRAVIS_REPO_SLUG")
+        repo = ENV["TRAVIS_REPO_SLUG"]
 
-function url(mod::Module, file::AbstractString, line::Integer)
-    file = Sys.iswindows() ? replace(file, '\\' => '/') : file
-    if Base.inbase(mod) && !isabspath(file)
-        local base = "https://github.com/JuliaLang/julia/tree"
-        if isempty(Base.GIT_VERSION_INFO.commit)
-            return "$base/v$VERSION/base/$file#L$line"
-        else
-            local commit = Base.GIT_VERSION_INFO.commit
-            return "$base/$commit/base/$file#L$line"
-        end
-    else
-        if isfile(file)
-            local d = dirname(file)
-            try # might not be in a git repo
-                LibGit2.with(LibGit2.GitRepoExt(d)) do repo
-                    LibGit2.with(LibGit2.GitConfig(repo)) do cfg
-                        local u = LibGit2.get(cfg, "remote.origin.url", "")
-                        local m = match(LibGit2.GITHUB_REGEX, u)
-                        u = m === nothing ? get(ENV, "TRAVIS_REPO_SLUG", "") : m.captures[1]
-                        local commit = string(LibGit2.head_oid(repo))
-                        local root = LibGit2.path(repo)
-                        if startswith(file, root) || startswith(realpath(file), root)
-                            local base = "https://github.com/$u/tree"
-                            local filename = file[(length(root) + 1):end]
-                            return "$base/$commit/$filename#L$line"
-                        else
-                            return ""
-                        end
-                    end
-                end
-            catch err
-                isa(err, LibGit2.GitError) || rethrow()
-                return ""
-            end
+        commit = get(ENV, "TRAVIS_COMMIT", nothing)
+        commit === nothing && return ""
+
+        root = get(ENV, "TRAVIS_BUILD_DIR", nothing)
+        root === nothing && return ""
+
+        file = realpath(string(m.file))
+        if startswith(file, root)
+            filename = join(split(relpath(file, root), @static Sys.iswindows() ? '\\' : '/'), '/')
+            base = "https://github.com/$repo/tree"
+            return "$base/$commit/$filename#L$(m.line)"
         else
             return ""
         end
+    else
+        return Base.url(m)
     end
 end
 

test/runtests.jl

@@ -2,5 +2,6 @@ using DocStringExtensions
 using Test
 import Markdown
 import LibGit2
+import REPL
 
 include("tests.jl")

test/tests.jl

@@ -40,15 +40,15 @@ end
         # Its signature is kwarg_decl(m::Method, kwtype::DataType). The second argument
         # should be the type of the kwsorter from the corresponding MethodTable.
         @test isa(methods(M.j_1), Base.MethodList)
-        @test isdefined(methods(M.j_1), :mt)
-        local mt = methods(M.j_1).mt
+        get_mt(func) = VERSION ≥ v"1.13.0-DEV.647" ? Core.GlobalMethods : methods(func).mt
+        local mt = get_mt(M.j_1)
         @test isa(mt, Core.MethodTable)
         if Base.fieldindex(Core.MethodTable, :kwsorter, false) > 0
             @test isdefined(mt, :kwsorter)
         end
         # .kwsorter is not always defined -- namely, it seems when none of the methods
         # have keyword arguments:
-        @test isdefined(methods(M.f).mt, :kwsorter) === false
+        @test isdefined(get_mt(M.f), :kwsorter) === false
         # M.j_1 has two methods. Fetch the single argument one..
         local m = which(M.j_1, (Any,))
         @test isa(m, Method)
@@ -61,7 +61,7 @@ end
         # that does not have any arguments
         m = which(M.j_1, (Any,Any)) # fetch the no-keyword method
         if VERSION < v"1.4.0-DEV.215"
-            @test Base.kwarg_decl(m, typeof(methods(M.j_1).mt.kwsorter)) == Tuple{}()
+            @test Base.kwarg_decl(m, typeof(get_mt(M.j_1).kwsorter)) == Tuple{}()
         else
             @test Base.kwarg_decl(m) == []
         end
@@ -83,7 +83,9 @@ end
             DSE.format(IMPORTS, buf, doc)
             str = String(take!(buf))
             @test occursin("\n  - `Base`\n", str)
-            @test occursin("\n  - `Core`\n", str)
+            if VERSION < v"1.13-DEV"
+                @test occursin("\n  - `Core`\n", str)
+            end
 
             # Module exports.
             DSE.format(EXPORTS, buf, doc)
@@ -151,8 +153,15 @@ end
             DSE.format(SIGNATURES, buf, doc)
             str = String(take!(buf))
             @test occursin("\n```julia\n", str)
-            @test occursin("\ng()\n", str)
-            @test occursin("\ng(x)\n", str)
+            # 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("\ng(; ...)\n", str)
+                @test occursin("\ng(x; ...)\n", str)
+            else
+                @test occursin("\ng()\n", str)
+                @test occursin("\ng()\n", str)
+            end
             @test occursin("\n```\n", str)
 
             doc.data = Dict(
@@ -163,9 +172,17 @@ end
             DSE.format(SIGNATURES, buf, doc)
             str = String(take!(buf))
             @test occursin("\n```julia\n", str)
-            @test occursin("\ng()\n", str)
-            @test occursin("\ng(x)\n", str)
-            @test occursin("\ng(x, y)\n", str)
+            # 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("\ng(; ...)\n", str)
+                @test occursin("\ng(x; ...)\n", str)
+                @test occursin("\ng(x, y; ...)\n", str)
+            else
+                @test occursin("\ng()\n", str)
+                @test occursin("\ng(x)\n", str)
+                @test occursin("\ng(x, y)\n", str)
+            end
             @test occursin("\ng(x, y, z; kwargs...)\n", str)
             @test occursin("\n```\n", str)
 
@@ -245,9 +262,21 @@ end
             str = String(take!(buf))
             @test occursin("\n```julia\n", str)
             if typeof(1) === Int64
-                @test occursin("\nh(x::Int64) -> Int64\n", str)
+                # 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; ...) -> Int64\n", str)
+                else
+                    @test occursin("\nh(x::Int64) -> Int64\n", str)
+                end
             else
-                @test occursin("\nh(x::Int32) -> Int32\n", str)
+                # 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; ...) -> Int32\n", str)
+                else
+                    @test occursin("\nh(x::Int32) -> Int32\n", str)
+                end
             end
             @test occursin("\n```\n", str)
 
@@ -671,6 +700,13 @@ end
                 @test occursin("github.com/JuliaDocs/NonExistent", DSE.url(first(methods(M.f))))
                 @test occursin("github.com/JuliaDocs/NonExistent", DSE.url(first(methods(M.K))))
             end
+            withenv(
+                "TRAVIS_REPO_SLUG" => "JuliaDocs/NonExistent",
+                "TRAVIS_COMMIT" => "<commit>",
+                "TRAVIS_BUILD_DIR" => dirname(@__DIR__)
+            ) do
+                @test occursin("github.com/JuliaDocs/NonExistent/tree/<commit>/test/TestModule/M.jl", DSE.url(first(methods(M.f))))
+            end
         end
         @testset "comparemethods" begin
             let f = first(methods(M.f)),