Merge pull request #542 from probcomp/docstring-test-fix

Fix docstring tests on Julia nightly / 1.11.
probcomp · Sep 5, 2024 · d5077de · d5077de
2 parents 5f8520b + 977a442
commit d5077de
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 6 deletions.
diff --git a/test/dsl/dynamic_dsl.jl b/test/dsl/dynamic_dsl.jl
@@ -534,16 +534,24 @@ end
 
 @testset "docstrings" begin
 
+    function doc_to_str(doc)
+        if doc isa Base.Docs.DocStr
+            # Handle @doc behavior in Julia 1.11 when REPL is not loaded
+            return doc.text[1]
+        else
+            # Handle pre-Julia 1.11 behavior of @doc
+            return string(doc)
+        end
+    end
+
     """
     my documentation
     """
     @gen function foo(x)
             return x + 1
     end
 
-    io = IOBuffer()
-    print(io, @doc foo)
-    @test String(take!(io)) == "my documentation\n"
+    @test doc_to_str(@doc(foo)) == "my documentation\n"
 
 end
 

diff --git a/test/dsl/static_dsl.jl b/test/dsl/static_dsl.jl
@@ -558,9 +558,16 @@ trace, = generate(foo, (), constraints)
 end
 
 @testset "docstrings" begin
-    io = IOBuffer()
-    print(io, @doc model)
-    @test String(take!(io)) == "my documentation\n"
+    function doc_to_str(doc)
+        if doc isa Base.Docs.DocStr
+            # Handle @doc behavior in Julia 1.11 when REPL is not loaded
+            return doc.text[1]
+        else
+            # Handle pre-Julia 1.11 behavior of @doc
+            return string(doc)
+        end
+    end
+    @test doc_to_str(@doc(model)) == "my documentation\n"
 end
 
 @testset "one-line definitions" begin