diff options
| author | Alex Chan <alex.chan@metaswitch.com> | 2015-07-29 14:00:18 +0100 |
|---|---|---|
| committer | Alex Chan <alex.chan@metaswitch.com> | 2015-07-29 14:00:18 +0100 |
| commit | 78ccfc88e873b621a5b4c5873155751e40aa9c1c (patch) | |
| tree | 70676f08c3f6550d05040d5bf6cbe04ddf58a26e /docs | |
| parent | 70dd6548428bc7b893be5cc7b4d9fc6cfc964506 (diff) | |
| download | docker-py-78ccfc88e873b621a5b4c5873155751e40aa9c1c.tar.gz | |
Fix a few typos in the docs
Signed-off-by: Alex Chan <alex.chan@metaswitch.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.md | 8 | ||||
| -rw-r--r-- | docs/change_log.md | 2 |
2 files changed, 5 insertions, 5 deletions
diff --git a/docs/api.md b/docs/api.md index d35e083..bccd526 100644 --- a/docs/api.md +++ b/docs/api.md @@ -30,7 +30,7 @@ the entire backlog. * container (str): The container to attach to * stdout (bool): Get STDOUT * stderr (bool): Get STDERR -* stream (bool): Return an interator +* stream (bool): Return an iterator * logs (bool): Get all previous output **Returns** (generator or str): The logs or output for the image @@ -70,7 +70,7 @@ correct value (e.g `gzip`). - memory (int): set memory limit for build - memswap (int): Total memory (memory + swap), -1 to disable swap - cpushares (int): CPU shares (relative weight) - - cpusetcpus (str): CPUs in which to allow exection, e.g., `"0-3"`, `"0,1"` + - cpusetcpus (str): CPUs in which to allow execution, e.g., `"0-3"`, `"0,1"` * decode (bool): If set to `True`, the returned stream will be decoded into dicts on the fly. Default `False`. @@ -123,7 +123,7 @@ Identical to the `docker commit` command. * tag (str): The tag to push * message (str): A commit message * author (str): The name of the author -* conf (dict): The configuraton for the container. See the [Docker remote api]( +* conf (dict): The configuration for the container. See the [Docker remote api]( https://docs.docker.com/reference/api/docker_remote_api/) for full details. ## containers @@ -397,7 +397,7 @@ src will be treated as a URL instead to fetch the image from. You can also pass an open file handle as 'src', in which case the data will be read from that file. -If `src` is unset but `image` is set, the `image` paramater will be taken as +If `src` is unset but `image` is set, the `image` parameter will be taken as the name of an existing image to import from. **Params**: diff --git a/docs/change_log.md b/docs/change_log.md index 538cca4..5e91861 100644 --- a/docs/change_log.md +++ b/docs/change_log.md @@ -21,7 +21,7 @@ Change Log * 404 API status now raises `docker.errors.NotFound`. This exception inherits `APIError` which was used previously. * Docs fixes -* Test ixes +* Test fixes 1.3.0 ----- |