Skip to content

Commit

Permalink
Better overview
Browse files Browse the repository at this point in the history
  • Loading branch information
Tortar authored Oct 9, 2024
1 parent e3f0037 commit 270cf31
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,17 +50,23 @@ also possible to iterate over a `StreamSample` like so
```julia
julia> using StreamSampling

julia> iter = 1:100
julia> iter = 1:100;

julia> ss = StreamSample{Int}(iter, 5, 100);

julia> collect(ss)
julia> r = Int[];

julia> for x in ss
push!(r, x)
end

julia> r
5-element Vector{Int64}:
7
9
20
49
74
10
22
26
35
75
```

Consult the [API page](https://juliadynamics.github.io/StreamSampling.jl/stable/api) for more information about the package interface.

0 comments on commit 270cf31

Please sign in to comment.