Merge pull request #116 from digital-carver/docdescribe

docs: add a package Description and a See Also section
JuliaCollections · Dec 14, 2023 · 0791c83 · 0791c83
2 parents 4e0c352 + 94e0d51
commit 0791c83
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -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"