diff options
author | Joffrey F <f.joffrey@gmail.com> | 2015-07-20 11:28:39 -0700 |
---|---|---|
committer | Joffrey F <f.joffrey@gmail.com> | 2015-07-20 11:28:39 -0700 |
commit | 1f5ba4b25da911b90db9c2506664dfae70342ffc (patch) | |
tree | 5be3f0632a8513bfa7b2c32d60c26ece3119c4d2 | |
parent | 4cfb15737db5192987276860cb0dc75812d8e4f2 (diff) | |
parent | 874be5b3338e80454c302b33eeb57cef7ab98e84 (diff) | |
download | docker-py-1f5ba4b25da911b90db9c2506664dfae70342ffc.tar.gz |
Merge pull request #678 from pdericson/docs
Minor fixes for docs/api.md
-rw-r--r-- | docs/api.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/api.md b/docs/api.md index f1e2d03..2dd175a 100644 --- a/docs/api.md +++ b/docs/api.md @@ -511,7 +511,7 @@ Kill a container or send a signal to a container **Params**: * container (str): The container to kill -* signal (str or int): The singal to send. Defaults to `SIGKILL` +* signal (str or int): The signal to send. Defaults to `SIGKILL` ## load_image @@ -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. |