[ci skip] Note on how files in benchmark/ are organized

JuliaArrays · Feb 19, 2020 · bd834ff · bd834ff
1 parent 403ea5a
commit bd834ff
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/benchmark/benchmarks.jl b/benchmark/benchmarks.jl
@@ -1,3 +1,7 @@
+# Each file of the form "bench_$(name).jl" in this directory is `include`d and
+# its last statement is assumed to be a `BenchmarkGroup`.  This group is added
+# to the top-level group `SUITE` with the `$name` extracted from the file name.
+
 using BenchmarkTools
 SUITE = BenchmarkGroup()
 for file in sort(readdir(@__DIR__))