docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix a few typos in the docs 

Signed-off-by: Alex Chan <alex.chan@metaswitch.com>
This commit is contained in:
Alex Chan 2015-07-29 14:00:18 +01:00
parent 70dd654842
commit 78ccfc88e8
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api.md
View File

@ -30,7 +30,7 @@ the entire backlog.
* container (str): The container to attach to * container (str): The container to attach to
* stdout (bool): Get STDOUT * stdout (bool): Get STDOUT
* stderr (bool): Get STDERR * stderr (bool): Get STDERR
* stream (bool): Return an interator * stream (bool): Return an iterator
* logs (bool): Get all previous output * logs (bool): Get all previous output
**Returns** (generator or str): The logs or output for the image **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 - memory (int): set memory limit for build
- memswap (int): Total memory (memory + swap), -1 to disable swap - memswap (int): Total memory (memory + swap), -1 to disable swap
- cpushares (int): CPU shares (relative weight) - 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 * decode (bool): If set to `True`, the returned stream will be decoded into
dicts on the fly. Default `False`. dicts on the fly. Default `False`.
@ -123,7 +123,7 @@ Identical to the `docker commit` command.
* tag (str): The tag to push * tag (str): The tag to push
* message (str): A commit message * message (str): A commit message
* author (str): The name of the author * 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. https://docs.docker.com/reference/api/docker_remote_api/) for full details.
## containers ## 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 an open file handle as 'src', in which case the data will be read from that
file. 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. the name of an existing image to import from.
**Params**: **Params**:

2
docs/change_log.md
View File

@ -21,7 +21,7 @@ Change Log
* 404 API status now raises `docker.errors.NotFound`. This exception inherits * 404 API status now raises `docker.errors.NotFound`. This exception inherits
`APIError` which was used previously. `APIError` which was used previously.
* Docs fixes * Docs fixes
* Test ixes * Test fixes
1.3.0 1.3.0
----- -----