Link FAQ from error message (#108)

Author: tkf

src/checkboxes.jl

@@ -134,22 +134,12 @@ function Base.showerror(io::IO, err::HasBoxedVariableError)
     end
 
     println(io)
-    printstyled(io, "HINT:", bold = true, color = :magenta)
-    var = get(varnames, 1, :x)
-    print(io, " Consider adding declarations such as `")
-    printstyled(io, "local ", var; color = :cyan)
-    print(io, "` at the narrowest possible scope required.")
-
-    println(io)
-    printstyled(io, "NOTE:", bold = true, color = :light_black)
+    print(io, "See: ")
     printstyled(
         io,
-        " This is very likely required for avoiding data races.",
-        " If boxing the variables is intended, use `Ref{Any}(...)`",
-        " instead.";
-        color = :light_black,
+        "https://juliafolds.github.io/FLoops.jl/dev/explanation/faq/#avoid-boxing";
+        color = :blue,
     )
-    # "To ignore this error, pass `allow_boxing = Val(true)` to the executor."
 
     println(io)
     printstyled(io, "NOTE:", bold = true, color = :light_black)

test/FLoopsTests/src/test_checkboxes.jl

@@ -80,18 +80,18 @@ function test_HasBoxedVariableError()
         err = HasBoxedVariableError(_make_closure_with_a_box())
         @debug "Example `HasBoxedVariableError`" err
         msg = sprint(showerror, err)
-        @test occursin("Consider adding declarations such as `local a`", msg)
         @test occursin("1 boxed variable:", msg)
         @test occursin(r"\b a \b"x, msg)
+        @test occursin("faq/#avoid-boxing", msg)
     end
     @testset "two boxes" begin
         err = HasBoxedVariableError(_make_closure_with_two_boxes())
         @debug "Example `HasBoxedVariableError`" err
         msg = sprint(showerror, err)
-        @test occursin(r"Consider adding declarations such as `local (a|b)`", msg)
         @test occursin("2 boxed variables:", msg)
         @test occursin(r"\b a \b"x, msg)
         @test occursin(r"\b b \b"x, msg)
+        @test occursin("faq/#avoid-boxing", msg)
     end
 end