From 94e0d516aee6606aaed0179fbba74af39908ebf8 Mon Sep 17 00:00:00 2001 From: SundaraRaman R Date: Wed, 8 Nov 2023 07:25:01 +0530 Subject: [PATCH] docs: add a package Description and a See Also section --- docs/src/index.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/src/index.md b/docs/src/index.md index 7f3f916..feec641 100644 --- 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"