Skip to content

Added documentation for decode param on stats and events #590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2015
Merged

Added documentation for decode param on stats and events #590

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,10 +250,10 @@ function return a blocking generator you can iterate over to retrieve events as
**Params**:

* since (datetime or int): get events from this point

* until (datetime or int): get events until this point

* 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):

Expand Down Expand Up @@ -812,6 +812,8 @@ This will stream statistics for a specific container.
**Params**:

* 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
>>> from docker import Client
Expand Down Expand Up @@ -914,7 +916,6 @@ If `container` a dict, the `Id` key is used.
<!---
TODO:

* events
* load_image
* resize

Expand Down