diff options
| author | Joffrey F <joffrey@docker.com> | 2015-01-12 14:16:13 -0800 |
|---|---|---|
| committer | Joffrey F <joffrey@docker.com> | 2015-01-12 14:16:13 -0800 |
| commit | 5794b98000c76752891ba2435516a3f755598ac6 (patch) | |
| tree | 4d2eaf5ad3af725f2d3de74e9990b646ec6ddeb6 | |
| parent | 349c6c5b4f8b00e04a3d132f7cb941d7cea78da1 (diff) | |
| download | docker-py-5794b98000c76752891ba2435516a3f755598ac6.tar.gz | |
Added deprecation warning for stream parameter in Client.build()
| -rw-r--r-- | docs/api.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/api.md b/docs/api.md index a4e7dd1..cfd8b07 100644 --- a/docs/api.md +++ b/docs/api.md @@ -53,8 +53,9 @@ correct value (e.g `gzip`). * fileobj: A file object to use as the Dockerfile. (Or a file-like object) * nocache (bool): Don't use the cache when set to `True` * rm (bool): Remove intermediate containers -* stream (bool): Return a blocking generator you can iterate over to retrieve - build output as it happens +* stream (bool): *Deprecated for API version > 1.8 (always True)*. + Return a blocking generator you can iterate over to retrieve build output as + it happens * timeout (int): HTTP timeout * custom_context (bool): Optional if using `fileobj` * encoding (str): The encoding for a stream. Set to `gzip` for compressing |