diff options
| author | Joffrey F <f.joffrey@gmail.com> | 2018-09-14 16:42:09 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-09-14 16:42:09 -0700 |
| commit | 87352cd05729bdddb4e7cb2941047ec566f8f8b0 (patch) | |
| tree | d8657e87052cc49b3822cfb8e9659edf15ed0788 | |
| parent | 02316eaf25637c972e08086ae739931032f51bf1 (diff) | |
| parent | 67308c1e55b8cc93276a52a2306d174e52b04cd4 (diff) | |
| download | docker-py-87352cd05729bdddb4e7cb2941047ec566f8f8b0.tar.gz | |
Merge pull request #2111 from bfirsh/document-defaults-of-logs
Document defaults of logs()
| -rw-r--r-- | docker/api/container.py | 10 | ||||
| -rw-r--r-- | docker/models/containers.py | 10 |
2 files changed, 10 insertions, 10 deletions
diff --git a/docker/api/container.py b/docker/api/container.py index d841606..d02ad78 100644 --- a/docker/api/container.py +++ b/docker/api/container.py @@ -765,16 +765,16 @@ class ContainerApiMixin(object): Args: container (str): The container to get logs from - stdout (bool): Get ``STDOUT`` - stderr (bool): Get ``STDERR`` - stream (bool): Stream the response - timestamps (bool): Show timestamps + stdout (bool): Get ``STDOUT``. Default ``True`` + stderr (bool): Get ``STDERR``. Default ``True`` + stream (bool): Stream the response. Default ``False`` + timestamps (bool): Show timestamps. Default ``False`` tail (str or int): Output specified number of lines at the end of logs. Either an integer of number of lines or the string ``all``. Default ``all`` since (datetime or int): Show logs since a given datetime or integer epoch (in seconds) - follow (bool): Follow log output + follow (bool): Follow log output. Default ``False`` until (datetime or int): Show logs that occurred before the given datetime or integer epoch (in seconds) diff --git a/docker/models/containers.py b/docker/models/containers.py index de6222e..14545a7 100644 --- a/docker/models/containers.py +++ b/docker/models/containers.py @@ -253,16 +253,16 @@ class Container(Model): generator you can iterate over to retrieve log output as it happens. Args: - stdout (bool): Get ``STDOUT`` - stderr (bool): Get ``STDERR`` - stream (bool): Stream the response - timestamps (bool): Show timestamps + stdout (bool): Get ``STDOUT``. Default ``True`` + stderr (bool): Get ``STDERR``. Default ``True`` + stream (bool): Stream the response. Default ``False`` + timestamps (bool): Show timestamps. Default ``False`` tail (str or int): Output specified number of lines at the end of logs. Either an integer of number of lines or the string ``all``. Default ``all`` since (datetime or int): Show logs since a given datetime or integer epoch (in seconds) - follow (bool): Follow log output + follow (bool): Follow log output. Default ``False`` until (datetime or int): Show logs that occurred before the given datetime or integer epoch (in seconds) |