Skip to content

Commit 5794b98

Browse files
committed
Added deprecation warning for stream parameter in Client.build()
1 parent 349c6c5 commit 5794b98

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/api.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,9 @@ correct value (e.g `gzip`).
5353
* fileobj: A file object to use as the Dockerfile. (Or a file-like object)
5454
* nocache (bool): Don't use the cache when set to `True`
5555
* rm (bool): Remove intermediate containers
56-
* stream (bool): Return a blocking generator you can iterate over to retrieve
57-
build output as it happens
56+
* stream (bool): *Deprecated for API version > 1.8 (always True)*.
57+
Return a blocking generator you can iterate over to retrieve build output as
58+
it happens
5859
* timeout (int): HTTP timeout
5960
* custom_context (bool): Optional if using `fileobj`
6061
* encoding (str): The encoding for a stream. Set to `gzip` for compressing

0 commit comments

Comments
 (0)