rename from BenchmarkPlots to BenchmarkHistograms (#4)

* rename

* rename file

* rename object

Author: ericphanson

Project.toml

@@ -1,4 +1,4 @@
-name = "BenchmarkPlots"
+name = "BenchmarkHistograms"
 uuid = "a80a1652-aad8-438d-b80b-ecb1a674e33b"
 authors = ["Eric Hanson <[email protected]> and contributors"]
 version = "0.1.0"

README.md

@@ -1,24 +1,24 @@
-[![CI](https://github.com/ericphanson/BenchmarkPlots.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/ericphanson/BenchmarkPlots.jl/actions/workflows/CI.yml)
-[![codecov](https://codecov.io/gh/ericphanson/BenchmarkPlots.jl/branch/main/graph/badge.svg?token=v0aca89xRi)](https://codecov.io/gh/ericphanson/BenchmarkPlots.jl)
+[![CI](https://github.com/ericphanson/BenchmarkHistograms.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/ericphanson/BenchmarkHistograms.jl/actions/workflows/CI.yml)
+[![codecov](https://codecov.io/gh/ericphanson/BenchmarkHistograms.jl/branch/main/graph/badge.svg?token=v0aca89xRi)](https://codecov.io/gh/ericphanson/BenchmarkHistograms.jl)
 
-# BenchmarkPlots
+# BenchmarkHistograms
 
 Wraps [BenchmarkTools.jl](https://github.com/JuliaCI/BenchmarkTools.jl/) to provide a UnicodePlots.jl-powered `show` method for `@benchmark`. This is accomplished by a custom `@benchmark` method which wraps the output in a `BenchmarkPlot` struct with a custom show method.
 
-This means one should not call `using` on both BenchmarkPlots and BenchmarkTools in the same namespace, or else these `@benchmark` macros will conflict ("WARNING: using `BenchmarkTools.@benchmark` in module Main conflicts with an existing identifier.")
+This means one should not call `using` on both BenchmarkHistograms and BenchmarkTools in the same namespace, or else these `@benchmark` macros will conflict ("WARNING: using `BenchmarkTools.@benchmark` in module Main conflicts with an existing identifier.")
 
-However, BenchmarkPlots re-exports all the export of BenchmarkTools, so you can simply call `using BenchmarkPlots`.
+However, BenchmarkHistograms re-exports all the export of BenchmarkTools, so you can simply call `using BenchmarkHistograms`.
 
 Providing this functionality in BenchmarkTools itself was discussed in <https://github.com/JuliaCI/BenchmarkTools.jl/pull/180>.
 
-Use the setting `BenchmarkPlots.NBINS[] = 10` to change the number of histogram bins used.
+Use the setting `BenchmarkHistograms.NBINS[] = 10` to change the number of histogram bins used.
 
 ## Example
 
-One just uses `BenchmarkPlots` instead of `BenchmarkTools`, e.g.
+One just uses `BenchmarkHistograms` instead of `BenchmarkTools`, e.g.
 
 ```julia
-using BenchmarkPlots
+using BenchmarkHistograms
 
 @benchmark sin(x) setup=(x=rand())
 ```
@@ -125,4 +125,3 @@ See also <https://tratt.net/laurie/blog/entries/minimum_times_tend_to_mislead_wh
 ---
 
 *This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).*
-

generate_readme/Manifest.toml

@@ -9,7 +9,7 @@ uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
 [[Base64]]
 uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
 
-[[BenchmarkPlots]]
+[[BenchmarkHistograms]]
 deps = ["BenchmarkTools", "Printf", "Statistics", "UnicodePlots"]
 path = ".."
 uuid = "a80a1652-aad8-438d-b80b-ecb1a674e33b"

generate_readme/Project.toml

@@ -1,3 +1,3 @@
 [deps]
-BenchmarkPlots = "a80a1652-aad8-438d-b80b-ecb1a674e33b"
+BenchmarkHistograms = "a80a1652-aad8-438d-b80b-ecb1a674e33b"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"

generate_readme/README.jl

@@ -1,23 +1,23 @@
-# [![CI](https://github.com/ericphanson/BenchmarkPlots.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/ericphanson/BenchmarkPlots.jl/actions/workflows/CI.yml)
-# [![codecov](https://codecov.io/gh/ericphanson/BenchmarkPlots.jl/branch/main/graph/badge.svg?token=v0aca89xRi)](https://codecov.io/gh/ericphanson/BenchmarkPlots.jl)
+# [![CI](https://github.com/ericphanson/BenchmarkHistograms.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/ericphanson/BenchmarkHistograms.jl/actions/workflows/CI.yml)
+# [![codecov](https://codecov.io/gh/ericphanson/BenchmarkHistograms.jl/branch/main/graph/badge.svg?token=v0aca89xRi)](https://codecov.io/gh/ericphanson/BenchmarkHistograms.jl)
 
-# # BenchmarkPlots
+# # BenchmarkHistograms
 
 # Wraps [BenchmarkTools.jl](https://github.com/JuliaCI/BenchmarkTools.jl/) to provide a UnicodePlots.jl-powered `show` method for `@benchmark`. This is accomplished by a custom `@benchmark` method which wraps the output in a `BenchmarkPlot` struct with a custom show method.
 
-# This means one should not call `using` on both BenchmarkPlots and BenchmarkTools in the same namespace, or else these `@benchmark` macros will conflict ("WARNING: using `BenchmarkTools.@benchmark` in module Main conflicts with an existing identifier.")
+# This means one should not call `using` on both BenchmarkHistograms and BenchmarkTools in the same namespace, or else these `@benchmark` macros will conflict ("WARNING: using `BenchmarkTools.@benchmark` in module Main conflicts with an existing identifier.")
 
-# However, BenchmarkPlots re-exports all the export of BenchmarkTools, so you can simply call `using BenchmarkPlots`.
+# However, BenchmarkHistograms re-exports all the export of BenchmarkTools, so you can simply call `using BenchmarkHistograms`.
 
 # Providing this functionality in BenchmarkTools itself was discussed in <https://github.com/JuliaCI/BenchmarkTools.jl/pull/180>.
 
-# Use the setting `BenchmarkPlots.NBINS[] = 10` to change the number of histogram bins used.
+# Use the setting `BenchmarkHistograms.NBINS[] = 10` to change the number of histogram bins used.
 
 # ## Example
 
-# One just uses `BenchmarkPlots` instead of `BenchmarkTools`, e.g.
+# One just uses `BenchmarkHistograms` instead of `BenchmarkTools`, e.g.
 
-using BenchmarkPlots
+using BenchmarkHistograms
 
 @benchmark sin(x) setup=(x=rand())
 

src/BenchmarkPlots.jl renamed to src/BenchmarkHistograms.jl

@@ -1,4 +1,4 @@
-module BenchmarkPlots
+module BenchmarkHistograms
 
 using UnicodePlots
 using Statistics
@@ -24,12 +24,12 @@ When `NBINS[] <= 0`, the number is chosen automatically by UnicodePlots.
 """
 const NBINS = Ref(0)
 
-struct BenchmarkPlot
+struct BenchmarkHistogram
     trial::BenchmarkTools.Trial
 end
 
 # borrowed some from `show` implementation for `BenchmarkTools.Trial`
-function Base.show(io::IO, ::MIME"text/plain", bp::BenchmarkPlot)
+function Base.show(io::IO, ::MIME"text/plain", bp::BenchmarkHistogram)
     t = bp.trial
     if length(t) > 0
         min = minimum(t)
@@ -60,7 +60,7 @@ end
 
 macro benchmark(exprs...)
     return quote
-        BenchmarkPlot(BenchmarkTools.@benchmark($(exprs...)))
+        BenchmarkHistogram(BenchmarkTools.@benchmark($(exprs...)))
     end
 end
 

test/runtests.jl

@@ -1,4 +1,4 @@
-using BenchmarkPlots
+using BenchmarkHistograms
 using Test
 
 function tests()
@@ -27,17 +27,17 @@ function tests()
 end
 
 function tests(nbins)
-    pre = BenchmarkPlots.NBINS[]
-    BenchmarkPlots.NBINS[] = nbins
+    pre = BenchmarkHistograms.NBINS[]
+    BenchmarkHistograms.NBINS[] = nbins
     try
         tests()
     finally
-        BenchmarkPlots.NBINS[] = pre
+        BenchmarkHistograms.NBINS[] = pre
     end
     return nothing
 end
 
-@testset "BenchmarkPlots.jl" begin
+@testset "BenchmarkHistograms.jl" begin
     tests()
     tests(10)
     tests(-1)