summaryrefslogtreecommitdiff
path: root/docs/api.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api.md')
-rw-r--r--docs/api.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/api.md b/docs/api.md
index 3b3a144..4b64147 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -71,8 +71,10 @@ correct value (e.g `gzip`).
- memswap (int): Total memory (memory + swap), -1 to disable swap
- cpushares (int): CPU shares (relative weight)
- cpusetcpus (str): CPUs in which to allow exection, e.g., `"0-3"`, `"0,1"`
+* decode (bool): If set to `True`, the returned stream will be decoded into
+ dicts on the fly. Default `False`.
-**Returns** (generator): A generator of the build output
+**Returns** (generator): A generator for the build output
```python
>>> from io import BytesIO