From 53a9ca45c9c0430da4732c1720f684e8a6484b7a Mon Sep 17 00:00:00 2001 From: Sofie Van Landeghem Date: Fri, 6 Sep 2019 11:11:54 +0200 Subject: [PATCH] Docs: bufsize instead of buffsize (#4247) --- website/docs/api/top-level.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/website/docs/api/top-level.md b/website/docs/api/top-level.md index 1030f1e67..9d166a5c5 100644 --- a/website/docs/api/top-level.md +++ b/website/docs/api/top-level.md @@ -639,7 +639,7 @@ Yield an infinite series of linearly decaying values. Shuffle an iterator. This works by holding `bufsize` items back and yielding them sometime later. Obviously, this is not unbiased – but should be good enough -for batching. Larger `buffsize` means less bias. +for batching. Larger `bufsize` means less bias. > #### Example > @@ -648,11 +648,11 @@ for batching. Larger `buffsize` means less bias. > shuffled = itershuffle(values) > ``` -| Name | Type | Description | -| ---------- | -------- | ---------------------- | -| `iterable` | iterable | Iterator to shuffle. | -| `buffsize` | int | Items to hold back. | -| **YIELDS** | iterable | The shuffled iterator. | +| Name | Type | Description | +| ---------- | -------- | ------------------------------------- | +| `iterable` | iterable | Iterator to shuffle. | +| `bufsize` | int | Items to hold back (default: 1000). | +| **YIELDS** | iterable | The shuffled iterator. | ### util.filter_spans {#util.filter_spans tag="function" new="2.1.4"}