Merge pull request #55 from JuliaConstraints/dev

New release

Author: Azzaare

.github/dependabot.yml

@@ -0,0 +1,7 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/CI.yml

@@ -50,9 +50,9 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - "1.9" # Minimal version of Julia for PerfChecker.jl
+          - "lts" # Minimal version of Julia for PerfChecker.jl
           - "1" # automatically expands to the latest stable 1.x release of Julia
-          - nightly
+          - "pre" # automatically expands to the latest pre-release of Julia"
         os:
           - ubuntu-latest
         arch:
@@ -71,7 +71,7 @@ jobs:
             version: 1
     steps:
       - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v1
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}

Project.toml

@@ -1,7 +1,7 @@
 name = "PerfChecker"
 uuid = "6309bf6b-a531-4b08-891e-8ee981e5c424"
 authors = ["Azzaare <jf@baffier.fr>"]
-version = "0.2.1"
+version = "0.2.2"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
@@ -29,21 +29,23 @@ MakieExt = "Makie"
 BenchmarkTools = "1"
 CSV = "0.10"
 Chairmarks = "1"
-CoverageTools = "1.3.1"
+CoverageTools = "1"
 CpuId = "0.3"
+Intervals = "1"
 JSON = "0.21"
 Makie = "0.21"
 Malt = "1"
 TOML = "1"
 TypedTables = "1"
-julia = "1.9"
+julia = "1.10"
 
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 Chairmarks = "0ca39b1e-fe0b-4e98-acfc-b1656634c4de"
+Intervals = "d8418881-c3e1-53bb-8760-2df7ec849ed5"
 PatternFolds = "c18a7f1d-76ad-4ce4-950d-5419b888513b"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Aqua", "BenchmarkTools", "Chairmarks", "PatternFolds", "Test"]
+test = ["Aqua", "BenchmarkTools", "Chairmarks", "Intervals", "PatternFolds", "Test"]

src/check.jl

@@ -145,6 +145,17 @@ function check_function(x::Symbol, d::Dict, block1, block2)
     return results
 end
 
+"""
+General usage:
+```julia
+@check :name_of_backend config_dictionary begin
+    # the prelimnary code
+end begin
+    # the actual code you want to do perf testing for
+end
+```
+Outputs a `CheckerResult` which can be used with other functions.  
+"""
 macro check(x, d, block1, block2)
     block1, block2 = Expr(:quote, block1), Expr(:quote, block2)
     quote
@@ -158,12 +169,34 @@ function perf_table end
 
 function perf_plot end
 
+"""
+General Usage:
+Takes a table generated via the check macro as input, and creates a pie plot. 
+"""
 function table_to_pie end
 
+"""
+General Usage:
+Takes the output of a check macro as input, and creates a scatterlines plot. 
+"""
 function checkres_to_scatterlines end
 
+"""
+General Usage:
+Takes the output of a check macro as input, and creates a pie plot. Uses `table_to_pie` internally. 
+"""
 function checkres_to_pie end
 
 function saveplot end
 
+"""
+General Usage:
+Takes the output of a check macro, and creates a boxplot. 
+"""
 function checkres_to_boxplots end
+
+"""
+General Usage:
+Returns a table from the output of the results of respective backends 
+"""
+function to_table end

src/checker_results.jl

@@ -25,6 +25,13 @@ function Base.show(io::IO, v::PerfChecker.CheckerResult)
     println(io, Base.display(v.pkgs))
 end
 
+"""
+Usage:
+(Assuming you ran the 'Basic Example')
+```
+julia> find_by_tags([:example, :nice, :great], res)
+```
+"""
 function find_by_tags(tags::Vector{Symbol}, results::CheckerResult; exact_match = true)
     findall(x -> exact_match ? (tags == x.tags) : (!isempty(x.tags ∩ tags)), results)
 end

test/Aqua.jl

@@ -5,7 +5,7 @@
     # TODO: Fix the broken tests and remove the `broken = true` flag
     Aqua.test_all(
         PerfChecker;
-        ambiguities = (broken = true,),
+        ambiguities = (broken = false,),
         deps_compat = false,
         piracies = (broken = false,)
     )

test/pattern_folds.jl

@@ -5,6 +5,7 @@
 
     x = @check :alloc d begin
         using PatternFolds
+        using Intervals
     end begin
         itv = Interval{Open, Closed}(0.0, 1.0)
         i = IntervalsFold(itv, 2.0, 1000)
@@ -36,6 +37,7 @@
 
     x2 = @check :benchmark d2 begin
         using PatternFolds
+        using Intervals
     end begin
         # Intervals
         itv = Interval{Open, Closed}(0.0, 1.0)
@@ -70,6 +72,7 @@
 
     x3 = @check :chairmark d3 begin
         using PatternFolds
+        using Intervals
     end begin
         # Intervals
         itv = Interval{Open, Closed}(0.0, 1.0)