From 9b68c1864145acff18b6ba757625a380fc67baf0 Mon Sep 17 00:00:00 2001
From: Neven Sajko <s@purelymail.com>
Date: Wed, 4 Mar 2026 17:59:43 +0100
Subject: [PATCH] doc: `partition` doc string: mention `Iterators.partition`

---
 src/IterTools.jl | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/IterTools.jl b/src/IterTools.jl
index 0fc05e8..b16df0a 100644
--- a/src/IterTools.jl
+++ b/src/IterTools.jl
@@ -312,6 +312,14 @@ i = (1, 2)
 i = (4, 5)
 i = (7, 8)
 ```
+
+`partition(i, n)` is very similar to `Iterators.partition(i, n)`. Some differences:
+
+* `Iterators.partition` does not accept a "step" argument.
+
+* `Iterators.partition` is type-stable in more cases.
+
+* When `partition` is type stable, it might cause less heap allocation than `Iterators.partition`.
 """
 @inline partition(xs, n::Int) = partition(xs, n, n)