summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Ericson <pdericson@gmail.com>2015-07-19 02:02:45 -0400
committerPeter Ericson <pdericson@gmail.com>2015-07-19 02:02:45 -0400
commit874be5b3338e80454c302b33eeb57cef7ab98e84 (patch)
tree408703ac65125992c7c90df7cc7ca9573a78a34c
parentbec21cfce1f8694e7d36f403c99e3354902c53cb (diff)
downloaddocker-py-874be5b3338e80454c302b33eeb57cef7ab98e84.tar.gz
docs/api.md: rework stats params
-rw-r--r--docs/api.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/api.md b/docs/api.md
index f73ad84..2dd175a 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -726,6 +726,10 @@ Identical to the `docker search` command.
Similar to the `docker start` command, but doesn't support attach options. Use
`.logs()` to recover `stdout`/`stderr`.
+**Params**:
+
+* container (str): The container to start
+
**Deprecation warning:** For API version > 1.15, it is highly recommended to
provide host config options in the
[`host_config` parameter of `create_container`](#create_container)
@@ -748,7 +752,7 @@ This will stream statistics for a specific container.
**Params**:
-* container (str): The container to start
+* 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.