docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #590 from docker/events_decode_doc 

Added documentation for decode param on stats and events
This commit is contained in:
Joffrey F 2015-05-07 13:50:28 -07:00
parent 02e771761f c3a48775b6
commit f28e90bfab
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/api.md
View File

@ -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.
**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.
<!--- <!---
TODO: TODO:
* events
* load_image * load_image
* resize * resize