Apply suggestions from code review

Co-authored-by: Miha Zgubic <mzgubic@users.noreply.github.com>

Author: oxinabox

src/check_result.jl

@@ -18,8 +18,7 @@ All keyword arguments are passed to `isapprox`.
 function check_equal(
     actual::Union{AbstractArray{<:Number},Number},
     expected::Union{AbstractArray{<:Number},Number},
-    msg="",
-    ;
+    msg="";
     kwargs...,
 )
     @test_msg msg isapprox(actual, expected; kwargs...)
@@ -74,7 +73,7 @@ function check_equal(actual::AbstractArray, expected::AbstractArray, msg=""; kwa
     if _can_pass_early(actual, expected)
         @test true
     else
-        @test_msg "$msg: indexes must match" eachindex(actual) == eachindex(expected)
+        @test_msg "$msg: indices must match" eachindex(actual) == eachindex(expected)
         for ii in eachindex(actual)
             new_msg = "$msg $(typeof(actual))[$ii]"
             check_equal(actual[ii], expected[ii], new_msg; kwargs...)
@@ -124,7 +123,7 @@ end
 check_equal(x, y::Tangent, msg=""; kwargs...) = check_equal(y, x, msg; kwargs...)
 
 # This catches comparisons of Tangents and Tuples/NamedTuple
-# and gives an error message complaining about that. the `@test` will definately fail
+# and gives an error message complaining about that. the `@test` will definitely fail
 const LegacyZygoteCompTypes = Union{Tuple,NamedTuple}
 function check_equal(x::Tangent, y::LegacyZygoteCompTypes, msg=""; kwargs...)
     @test_msg "$msg: for structural differentials use `Tangent`" typeof(x) === typeof(y)

src/output_control.jl

@@ -41,6 +41,9 @@ julia> @test_msg a sum(1:1000) < 10;
 ```
 """
 macro test_msg(msg, ex, kws...)
+    # This code is basically a evil hack that accesses the internals of the Test stdlib.
+    # Code below is based on the `@test` macro definition as it was in Julia 1.6.
+    # https://github.com/JuliaLang/julia/blob/v1.6.1/stdlib/Test/src/Test.jl#L371-L376
     Test.test_expr!("@test_msg msg", ex, kws...)
 
     result = Test.get_test_result(ex, __source__)