diff options
author | Joffrey F <joffrey@docker.com> | 2015-05-07 13:37:56 -0700 |
---|---|---|
committer | Joffrey F <joffrey@docker.com> | 2015-05-07 13:38:12 -0700 |
commit | c3a48775b61a5450d22e1add4000fb33d2ddf233 (patch) | |
tree | 3a34ea448c1270b93770e484203efb72762748fe | |
parent | 02e771761f6abc1a9208ef3d449dc96bb05e0ac2 (diff) | |
download | docker-py-events_decode_doc.tar.gz |
Added documentation for decode param on stats and eventsevents_decode_doc
-rw-r--r-- | docs/api.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/api.md b/docs/api.md index a4aabb5..eaa08a1 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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): @@ -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 @@ -914,7 +916,6 @@ If `container` a dict, the `Id` key is used. <!--- TODO: -* events * load_image * resize |