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

Merge pull request #2181 from funkyfuture/exec_run_docs 

Fixes the documented return value of models.containers.Container.exec_run
This commit is contained in:
Joffrey F 2018-11-30 14:44:08 -08:00 committed by GitHub
parent 9a67e2032e 3fca75ffef
commit 666388168d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docker/models/containers.py
View File

@ -172,10 +172,10 @@ class Container(Model):
exit_code: (int): exit_code: (int):
Exit code for the executed command or ``None`` if Exit code for the executed command or ``None`` if
either ``stream```or ``socket`` is ``True``. either ``stream```or ``socket`` is ``True``.
output: (generator or str): output: (generator or bytes):
If ``stream=True``, a generator yielding response chunks. If ``stream=True``, a generator yielding response chunks.
If ``socket=True``, a socket object for the connection. If ``socket=True``, a socket object for the connection.
A string containing response data otherwise. A bytestring containing response data otherwise.
Raises: Raises:
:py:class:`docker.errors.APIError` :py:class:`docker.errors.APIError`