Skip to content

Minor fixes for docs/api.md #678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 20, 2015
Merged

Minor fixes for docs/api.md #678

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bec21cf
docs/api.md: singal -> signal
pdericson Jul 19, 2015
874be5b
docs/api.md: rework stats params
pdericson Jul 19, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
Expand All @@ -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.

Expand Down