Add clarification about direction of slowness

halleysfifthinc · Aug 23, 2024 · dcf1135 · dcf1135 · halleysfifthinc · Aug 23, 2024
1 parent e28e804
commit dcf1135
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -59,18 +59,18 @@ jobs:
           version: '1'
       - uses: julia-actions/cache@v1
       - run: |
-          julia --project=docs -e '
+          julia --color=auto --project=docs -e '
             using Pkg
             Pkg.Registry.update()
             Pkg.develop(PackageSpec(path=pwd()))
             Pkg.instantiate()'
       - run: |
-          julia --project=docs -e '
+          julia --color=auto --project=docs -e '
             using Documenter: DocMeta, doctest
             using Peaks
             DocMeta.setdocmeta!(Peaks, :DocTestSetup, :(using Peaks); recursive=true)
             doctest(Peaks)'
-      - run: julia --project=docs docs/make.jl
+      - run: julia --color=auto --project=docs docs/make.jl
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
diff --git a/docs/src/benchmarks.md b/docs/src/benchmarks.md
@@ -36,7 +36,8 @@ variably[^2].
     function; more predictable branches will make the function run faster than could be
     expected with more realistic data.
 
-When benchmarking against randomly sampled data, we see roughly the same performance characteristics, now presented relative to the speed of `simplemaxima`:
+When benchmarking against randomly sampled data, we see roughly the same performance
+characteristics, now presented relative to the speed of `simplemaxima` (higher is slower):
 
 ```@example benchmark_plots
 ratio_plot # hide