Unverified Kaydet (Commit) 67308c1e authored tarafından Ben Firshman's avatar Ben Firshman

Document defaults of logs()

This is not obvious because some are True by default.
Signed-off-by: 's avatarBen Firshman <ben@firshman.co.uk>
üst e78e4e74
...@@ -765,16 +765,16 @@ class ContainerApiMixin(object): ...@@ -765,16 +765,16 @@ class ContainerApiMixin(object):
Args: Args:
container (str): The container to get logs from container (str): The container to get logs from
stdout (bool): Get ``STDOUT`` stdout (bool): Get ``STDOUT``. Default ``True``
stderr (bool): Get ``STDERR`` stderr (bool): Get ``STDERR``. Default ``True``
stream (bool): Stream the response stream (bool): Stream the response. Default ``False``
timestamps (bool): Show timestamps timestamps (bool): Show timestamps. Default ``False``
tail (str or int): Output specified number of lines at the end of tail (str or int): Output specified number of lines at the end of
logs. Either an integer of number of lines or the string logs. Either an integer of number of lines or the string
``all``. Default ``all`` ``all``. Default ``all``
since (datetime or int): Show logs since a given datetime or since (datetime or int): Show logs since a given datetime or
integer epoch (in seconds) 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 until (datetime or int): Show logs that occurred before the given
datetime or integer epoch (in seconds) datetime or integer epoch (in seconds)
......
...@@ -253,16 +253,16 @@ class Container(Model): ...@@ -253,16 +253,16 @@ class Container(Model):
generator you can iterate over to retrieve log output as it happens. generator you can iterate over to retrieve log output as it happens.
Args: Args:
stdout (bool): Get ``STDOUT`` stdout (bool): Get ``STDOUT``. Default ``True``
stderr (bool): Get ``STDERR`` stderr (bool): Get ``STDERR``. Default ``True``
stream (bool): Stream the response stream (bool): Stream the response. Default ``False``
timestamps (bool): Show timestamps timestamps (bool): Show timestamps. Default ``False``
tail (str or int): Output specified number of lines at the end of tail (str or int): Output specified number of lines at the end of
logs. Either an integer of number of lines or the string logs. Either an integer of number of lines or the string
``all``. Default ``all`` ``all``. Default ``all``
since (datetime or int): Show logs since a given datetime or since (datetime or int): Show logs since a given datetime or
integer epoch (in seconds) 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 until (datetime or int): Show logs that occurred before the given
datetime or integer epoch (in seconds) datetime or integer epoch (in seconds)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment