summaryrefslogtreecommitdiff
path: root/docs/api.md
diff options
context:
space:
mode:
authorAntonis Kalipetis <akalipetis@gmail.com>2015-10-09 11:57:37 +0000
committerAntonis Kalipetis <akalipetis@gmail.com>2015-10-22 10:23:53 +0000
commit019a365a0243046888ad03a10eeb9a00ffff6eaa (patch)
treeb6eaf4bf21cec0d64fafd2c13e989f9dc5d016fe /docs/api.md
parenta11c11430a1025e616aedaa1335ede88128d4a20 (diff)
downloaddocker-py-019a365a0243046888ad03a10eeb9a00ffff6eaa.tar.gz
Enhance docs for stats method
Signed-off-by: Antonis Kalipetis <akalipetis@gmail.com>
Diffstat (limited to 'docs/api.md')
-rw-r--r--docs/api.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md
index 2aa70b5..1e9a19c 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -873,6 +873,8 @@ This will stream statistics for a specific container.
* container (str): The container to stream statistics for
* decode (bool): If set to true, stream will be decoded into dicts on the
fly. False by default.
+* stream (bool): If set to false, only the current stats will be returned
+ instead of a stream. True by default.
```python
>>> from docker import Client