From: Daniel Holth <dholth@anaconda.com>
Date: Fri, 24 Jun 2022 13:36:45 +0000 (-0400)
Subject: add `[chunk_size]` for `a?iter_.*` methods (#2281)
X-Git-Tag: 0.23.1~54
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=aad60a4f123801e7ce0e02bc49138e7f0f9ca0a5;p=thirdparty%2Fhttpx.git

add `[chunk_size]` for `a?iter_.*` methods (#2281)

```
    def iter_bytes(
        self, chunk_size: typing.Optional[int] = None
    ) -> typing.Iterator[bytes]:
```
---

diff --git a/docs/api.md b/docs/api.md
index c644f8a3..3f806b6f 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -73,17 +73,17 @@
 * `def .raise_for_status()` - **None**
 * `def .json()` - **Any**
 * `def .read()` - **bytes**
-* `def .iter_raw()` - **bytes iterator**
-* `def .iter_bytes()` - **bytes iterator**
-* `def .iter_text()` - **text iterator**
-* `def .iter_lines()` - **text iterator**
+* `def .iter_raw([chunk_size])` - **bytes iterator**
+* `def .iter_bytes([chunk_size])` - **bytes iterator**
+* `def .iter_text([chunk_size])` - **text iterator**
+* `def .iter_lines([chunk_size])` - **text iterator**
 * `def .close()` - **None**
 * `def .next()` - **Response**
 * `def .aread()` - **bytes**
-* `def .aiter_raw()` - **async bytes iterator**
-* `def .aiter_bytes()` - **async bytes iterator**
-* `def .aiter_text()` - **async text iterator**
-* `def .aiter_lines()` - **async text iterator**
+* `def .aiter_raw([chunk_size])` - **async bytes iterator**
+* `def .aiter_bytes([chunk_size])` - **async bytes iterator**
+* `def .aiter_text([chunk_size])` - **async text iterator**
+* `def .aiter_lines([chunk_size])` - **async text iterator**
 * `def .aclose()` - **None**
 * `def .anext()` - **Response**