diff options
| author | Max Fan <root@max.fan> | 2022-07-29 16:15:58 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-29 16:15:58 -0400 |
| commit | dff849f6bb7d6805f52dd2112b8666c86d3f3235 (patch) | |
| tree | 0c3d512884dc538099da964b174296cca062c439 | |
| parent | 52fb27690c073638134b45cd462ab0c091f393a5 (diff) | |
| download | docker-py-dff849f6bb7d6805f52dd2112b8666c86d3f3235.tar.gz | |
docs: image build clarifications/grammar (#2489)
I changed was build > was built and reorganized a few sentences to be more clear.
Signed-off-by: InnovativeInventor <theinnovativeinventor@gmail.com>
| -rw-r--r-- | docker/models/images.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docker/models/images.py b/docker/models/images.py index 79ccbe4..ae4e294 100644 --- a/docker/models/images.py +++ b/docker/models/images.py @@ -224,10 +224,10 @@ class ImageCollection(Collection): Build an image and return it. Similar to the ``docker build`` command. Either ``path`` or ``fileobj`` must be set. - If you have a tar file for the Docker build context (including a - Dockerfile) already, pass a readable file-like object to ``fileobj`` - and also pass ``custom_context=True``. If the stream is compressed - also, set ``encoding`` to the correct value (e.g ``gzip``). + If you already have a tar file for the Docker build context (including a + Dockerfile), pass a readable file-like object to ``fileobj`` + and also pass ``custom_context=True``. If the stream is also compressed, + set ``encoding`` to the correct value (e.g ``gzip``). If you want to get the raw output of the build, use the :py:meth:`~docker.api.build.BuildApiMixin.build` method in the @@ -284,7 +284,7 @@ class ImageCollection(Collection): Returns: (tuple): The first item is the :py:class:`Image` object for the - image that was build. The second item is a generator of the + image that was built. The second item is a generator of the build logs as JSON-decoded objects. Raises: |