Skip to content

Commit 204d018

Browse files
authored
Improve docs (#117)
1 parent bb27225 commit 204d018

File tree

3 files changed

+12
-5
lines changed

3 files changed

+12
-5
lines changed

docs/make.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ makedocs(
1212
"StreamSampling.jl" => "index.md",
1313
"Basics" => "basics.md",
1414
"An Illustrative Example" => "example.md",
15-
"API" => "api.md",
1615
"Performance Tips" => "perf_tips.md",
17-
"Benchmarks" => "benchmark.md"
16+
"Benchmarks" => "benchmark.md",
17+
"API" => "api.md",
1818
],
1919
warnonly = [:doctest, :missing_docs, :cross_references],
2020
)

docs/src/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11

2-
# StreamSampling.jl
2+
# Introduction
33

44
```@docs
55
StreamSampling
66
```
77

8+
## Installation
9+
10+
```julia
11+
using Pkg
12+
Pkg.add("StreamSampling")
13+
```
14+
815
## Reproducibility
916

1017
```@raw html

docs/src/perf_tips.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ iter = 1:10^7;
2626
Running with both version we get
2727

2828
```@example 1
29-
@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = true))
29+
@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = true));
3030
```
3131

3232
```@example 1
33-
@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = false))
33+
@btime fit_iter!(rs, $iter) setup=(rs = ReservoirSampler{Int}(10, AlgRSWRSKIP(); mutable = false));
3434
```
3535

3636
As you can see, the immutable version is 50% faster than

0 commit comments

Comments
 (0)