Kaydet (Commit) f28e90bf authored tarafından Joffrey F's avatar Joffrey F

Merge pull request #590 from docker/events_decode_doc

Added documentation for decode param on stats and events
...@@ -250,10 +250,10 @@ function return a blocking generator you can iterate over to retrieve events as ...@@ -250,10 +250,10 @@ function return a blocking generator you can iterate over to retrieve events as
**Params**: **Params**:
* since (datetime or int): get events from this point * since (datetime or int): get events from this point
* until (datetime or int): get events until this point * until (datetime or int): get events until this point
* filters (dict): filter the events by event time, container or image * filters (dict): filter the events by event time, container or image
* decode (bool): If set to true, stream will be decoded into dicts on the
fly. False by default.
**Returns** (generator): **Returns** (generator):
...@@ -812,6 +812,8 @@ This will stream statistics for a specific container. ...@@ -812,6 +812,8 @@ This will stream statistics for a specific container.
**Params**: **Params**:
* container (str): The container to start * container (str): The container to start
* decode (bool): If set to true, stream will be decoded into dicts on the
fly. False by default.
```python ```python
>>> from docker import Client >>> from docker import Client
...@@ -914,7 +916,6 @@ If `container` a dict, the `Id` key is used. ...@@ -914,7 +916,6 @@ If `container` a dict, the `Id` key is used.
<!--- <!---
TODO: TODO:
* events
* load_image * load_image
* resize * resize
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment