Fix adding docstring to module with none (#585)

Workaround for julia#38819 Fixes #583
timholy · Dec 10, 2020 · 40ce40c · 40ce40c
1 parent 1dd0a70
commit 40ce40c
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/src/lowered.jl b/src/lowered.jl
@@ -415,6 +415,10 @@ function methods_by_execution!(@nospecialize(recurse), methodinfo, docexprs, fra
                             dmod = tmpvar
                         end
                     end
+                    # Workaround for julia#38819 on older Julia versions
+                    if !isdefined(dmod, Base.Docs.META)
+                        Base.Docs.initmeta(dmod)
+                    end
                     m = get!(Base.Docs.meta(dmod), b, Base.Docs.MultiDoc())::Base.Docs.MultiDoc
                     if haskey(m.docs, sig)
                         currentstr = m.docs[sig]::Base.Docs.DocStr

diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1163,6 +1163,7 @@ end
             println(io, """
             module ChangeDocstring
             "f" f() = 1
+            g() = 1
             end
             """)
         end
@@ -1172,17 +1173,23 @@ end
         @test ChangeDocstring.f() == 1
         ds = @doc(ChangeDocstring.f)
         @test get_docstring(ds) == "f"
+        @test ChangeDocstring.g() == 1
+        ds = @doc(ChangeDocstring.g)
+        @test get_docstring(ds) == "No documentation found."
         # Ordinary route
         open(joinpath(dn, "ChangeDocstring.jl"), "w") do io
             println(io, """
             module ChangeDocstring
             "h" f() = 1
+            "g" g() = 1
             end
             """)
         end
         yry()
         ds = @doc(ChangeDocstring.f)
         @test get_docstring(ds) == "h"
+        ds = @doc(ChangeDocstring.g)
+        @test get_docstring(ds) == "g"
 
         # Now manually change the docstring
         ex = quote "g" f() = 1 end
@@ -1196,6 +1203,35 @@ end
         @test get_docstring(ds) == "g"
 
         rm_precompile("ChangeDocstring")
+
+        # Test for #583
+        dn = joinpath(testdir, "FirstDocstring", "src")
+        mkpath(dn)
+        open(joinpath(dn, "FirstDocstring.jl"), "w") do io
+            println(io, """
+            module FirstDocstring
+            g() = 1
+            end
+            """)
+        end
+        sleep(mtimedelay)
+        @eval using FirstDocstring
+        sleep(mtimedelay)
+        @test FirstDocstring.g() == 1
+        ds = @doc(FirstDocstring.g)
+        @test get_docstring(ds) == "No documentation found."
+        open(joinpath(dn, "FirstDocstring.jl"), "w") do io
+            println(io, """
+            module FirstDocstring
+            "g" g() = 1
+            end
+            """)
+        end
+        yry()
+        ds = @doc(FirstDocstring.g)
+        @test get_docstring(ds) == "g"
+
+        rm_precompile("FirstDocstring")
         pop!(LOAD_PATH)
     end