Skip to content

Commit

Permalink
docs: add a package Description and a See Also section
Browse files Browse the repository at this point in the history
  • Loading branch information
digital-carver committed Dec 1, 2023
1 parent 4e0c352 commit 94e0d51
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,18 @@

Install this package with `Pkg.add("IterTools")`

## Description

Common functional iterator patterns.

This package provides tools for working with iterators, in addition to those provided by `Base.Iterators`. It is lightweight and has no dependencies.

## Index
```@index
Modules = [IterTools]
```

## See also

* [`Base.Iterators`](https://docs.julialang.org/en/v1/base/iterators/) is included with Julia
* [SplitApplyCombine.jl](https://github.com/JuliaData/SplitApplyCombine.jl) has "tools [that] come in the form of high-level functions that operate on iterable or indexable containers in an intuitive and simple way"

0 comments on commit 94e0d51

Please sign in to comment.