From c3a48775b61a5450d22e1add4000fb33d2ddf233 Mon Sep 17 00:00:00 2001 From: Joffrey F Date: Thu, 7 May 2015 13:37:56 -0700 Subject: Added documentation for decode param on stats and events --- docs/api.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'docs') 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.