From 15a0f8b64377a243c9403f175e31a4d657b5919b Mon Sep 17 00:00:00 2001 From: Adriano Meligrana <68152031+Tortar@users.noreply.github.com> Date: Wed, 13 Aug 2025 02:43:56 +0200 Subject: [PATCH 1/5] Improve docs --- docs/src/perf_tips.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/perf_tips.md b/docs/src/perf_tips.md index 7fe632cf..e7355c22 100644 --- a/docs/src/perf_tips.md +++ b/docs/src/perf_tips.md @@ -26,11 +26,11 @@ iter = 1:10^7; Running with both version we get ```@example 1 -@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = true)) +@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = true)); ``` ```@example 1 -@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = false)) +@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = false)); ``` As you can see, the immutable version is 50% faster than From 61f0f37c4470de9a337e121e47213dd314c740ec Mon Sep 17 00:00:00 2001 From: Adriano Meligrana <68152031+Tortar@users.noreply.github.com> Date: Wed, 13 Aug 2025 02:45:28 +0200 Subject: [PATCH 2/5] Update index.md --- docs/src/index.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/src/index.md b/docs/src/index.md index 7b9e9f52..7cc404b8 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,10 +1,17 @@ -# StreamSampling.jl +# Introduction ```@docs StreamSampling ``` +## Installation + +```julia +using Pkg +Pkg.add("BeforeIT") +``` + ## Reproducibility ```@raw html From 6f0fdc5ec9568e5077d0924b67a270cfb6163eb3 Mon Sep 17 00:00:00 2001 From: Adriano Meligrana <68152031+Tortar@users.noreply.github.com> Date: Wed, 13 Aug 2025 02:45:51 +0200 Subject: [PATCH 3/5] Update index.md --- docs/src/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/index.md b/docs/src/index.md index 7cc404b8..df99010d 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -9,7 +9,7 @@ StreamSampling ```julia using Pkg -Pkg.add("BeforeIT") +Pkg.add("StreamSampling") ``` ## Reproducibility From 259f94cb5d114d71585451e4e022c5a6d600717d Mon Sep 17 00:00:00 2001 From: Adriano Meligrana <68152031+Tortar@users.noreply.github.com> Date: Wed, 13 Aug 2025 02:46:26 +0200 Subject: [PATCH 4/5] Update make.jl --- docs/make.jl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index b53cf71f..5d762d65 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -14,9 +14,9 @@ makedocs( "StreamSampling.jl" => "index.md", "Basics" => "basics.md", "An Illustrative Example" => "example.md", - "API" => "api.md", "Performance Tips" => "perf_tips.md", "Benchmarks" => "benchmark.md" + "API" => "api.md", ], warnonly = [:doctest, :missing_docs, :cross_references], ) @@ -31,4 +31,4 @@ if CI devbranch = "main", ) end -println("Finished building and deploying docs.") \ No newline at end of file +println("Finished building and deploying docs.") From 151d93ad21d9bf76a4564bf80e25c519b67b14c5 Mon Sep 17 00:00:00 2001 From: Adriano Meligrana <68152031+Tortar@users.noreply.github.com> Date: Wed, 13 Aug 2025 02:48:37 +0200 Subject: [PATCH 5/5] Update make.jl --- docs/make.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/make.jl b/docs/make.jl index 5d762d65..0396998a 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -15,7 +15,7 @@ makedocs( "Basics" => "basics.md", "An Illustrative Example" => "example.md", "Performance Tips" => "perf_tips.md", - "Benchmarks" => "benchmark.md" + "Benchmarks" => "benchmark.md", "API" => "api.md", ], warnonly = [:doctest, :missing_docs, :cross_references],