Fix docs for Experimental.@force_compile (#42760)

Also adds a direct test
JuliaLang · Oct 23, 2021 · 030a0f9 · 030a0f9 · nanosoldier · Oct 23, 2021
1 parent 6ab06b8
commit 030a0f9
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 11 deletions.
diff --git a/base/experimental.jl b/base/experimental.jl
@@ -170,17 +170,18 @@ Force compilation of the block or function (Julia's built-in interpreter is bloc
 # Examples
 
 ```
-module WithPrecompiles
-#=
-    code definitions
-=#
-
-if Sys.iswindows()
-    Experimental.@compile
-    compile_me()  # `compile_me` will be compiled before execution
-end
-
-end
+julia> occursin("interpreter", string(stacktrace(begin
+           # with forced compilation
+           Base.Experimental.@force_compile
+           backtrace()
+       end, true)))
+false
+
+julia> occursin("interpreter", string(stacktrace(begin
+           # without forced compilation
+           backtrace()
+       end, true)))
+true
 ```
 """
 macro force_compile() Expr(:meta, :force_compile) end

diff --git a/test/core.jl b/test/core.jl
@@ -7589,3 +7589,14 @@ end
 
 # avoid impossible normalization (don't try to form Tuple{Complex{String}} here)
 @test Tuple{Complex{T} where String<:T<:String} == Tuple{Complex{T} where String<:T<:String}
+
+# control over compilation/interpreter
+@test !occursin("interpreter", string(stacktrace(
+    begin
+        Base.Experimental.@force_compile
+        backtrace()
+    end, true)))
+@test  occursin("interpreter", string(stacktrace(
+    begin
+        backtrace()
+    end, true)))