From fb30cca59127475a10c0961cf660d85c035ed7ee Mon Sep 17 00:00:00 2001
From: Raymond Hettinger <python@rcn.com>
Date: Mon, 9 Mar 2009 11:58:33 +0000
Subject: [PATCH] Add consume() recipe to itertools docs.

---
 Doc/library/itertools.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Doc/library/itertools.rst b/Doc/library/itertools.rst
index baa3566edfa..d4d130fea6d 100644
--- a/Doc/library/itertools.rst
+++ b/Doc/library/itertools.rst
@@ -635,6 +635,10 @@ which incur interpreter overhead.
        "Return function(0), function(1), ..."
        return imap(function, count(start))
 
+   def consume(iterator, n):
+       "Advance the iterator n-steps ahead. If n is none, consume entirely."
+       collections.deque(islice(iterator, n), maxlen=0)
+
    def nth(iterable, n, default=None):
        "Returns the nth item or a default value"
        return next(islice(iterable, n, None), default)