Skip to content

Commit f28e90b

Browse files
committed
Merge pull request #590 from docker/events_decode_doc
Added documentation for decode param on stats and events
2 parents 02e7717 + c3a4877 commit f28e90b

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/api.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,10 +250,10 @@ function return a blocking generator you can iterate over to retrieve events as
250250
**Params**:
251251

252252
* since (datetime or int): get events from this point
253-
254253
* until (datetime or int): get events until this point
255-
256254
* filters (dict): filter the events by event time, container or image
255+
* decode (bool): If set to true, stream will be decoded into dicts on the
256+
fly. False by default.
257257

258258
**Returns** (generator):
259259

@@ -812,6 +812,8 @@ This will stream statistics for a specific container.
812812
**Params**:
813813

814814
* container (str): The container to start
815+
* decode (bool): If set to true, stream will be decoded into dicts on the
816+
fly. False by default.
815817

816818
```python
817819
>>> from docker import Client
@@ -914,7 +916,6 @@ If `container` a dict, the `Id` key is used.
914916
<!---
915917
TODO:
916918

917-
* events
918919
* load_image
919920
* resize
920921

0 commit comments

Comments
 (0)