Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 69ef9e5

Browse files
committedJul 8, 2015
Added missing Client.load_image docs
Clarified `Client.wait` docs
1 parent 28d0840 commit 69ef9e5

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed
 

‎docs/api.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -513,6 +513,15 @@ Kill a container or send a signal to a container
513513
* container (str): The container to kill
514514
* signal (str or int): The singal to send. Defaults to `SIGKILL`
515515

516+
## load_image
517+
518+
Load an image that was previously saved using `Client.get_image`
519+
(or `docker save`). Similar to `docker load`.
520+
521+
**Params**:
522+
523+
* data (binary): Image data to be loaded
524+
516525
## login
517526

518527
Nearly identical to the `docker login` command, but non-interactive.
@@ -828,10 +837,13 @@ Nearly identical to the `docker version` command.
828837

829838
## wait
830839
Identical to the `docker wait` command. Block until a container stops, then
831-
print its exit code. Returns the value `-1` if no `StatusCode` is returned by
832-
the API.
840+
return its exit code. Returns the value `-1` if the API responds without a
841+
`StatusCode` attribute.
833842

834-
If `container` a dict, the `Id` key is used.
843+
If `container` is a dict, the `Id` key is used.
844+
845+
If the timeout value is exceeded, a `requests.exceptions.ReadTimeout`
846+
exception will be raised.
835847

836848
**Params**:
837849

0 commit comments

Comments
 (0)
Please sign in to comment.