summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2017-11-01 17:13:28 -0700
committerJoffrey F <joffrey@docker.com>2017-11-06 19:21:03 -0800
commit7cadb434cb909ffc8a7098ab2867c192149d22cf (patch)
treeb6d278f5b04e7d47a386d72e28a40004b19d4e52
parent97fc3f9efe5bd456ffa0a5069ebe340874f2b418 (diff)
downloaddocker-py-7cadb434cb909ffc8a7098ab2867c192149d22cf.tar.gz
Doc fixes
Signed-off-by: Joffrey F <joffrey@docker.com>
-rw-r--r--docker/api/build.py4
-rw-r--r--docker/api/plugin.py8
-rw-r--r--docker/types/healthcheck.py13
-rw-r--r--docker/types/services.py17
4 files changed, 22 insertions, 20 deletions
diff --git a/docker/api/build.py b/docker/api/build.py
index 25f271a..9ff2dfb 100644
--- a/docker/api/build.py
+++ b/docker/api/build.py
@@ -93,8 +93,8 @@ class BuildApiMixin(object):
shmsize (int): Size of `/dev/shm` in bytes. The size must be
greater than 0. If omitted the system uses 64MB
labels (dict): A dictionary of labels to set on the image
- cache_from (list): A list of images used for build cache
- resolution
+ cache_from (:py:class:`list`): A list of images used for build
+ cache resolution
target (str): Name of the build-stage to build in a multi-stage
Dockerfile
network_mode (str): networking mode for the run commands during
diff --git a/docker/api/plugin.py b/docker/api/plugin.py
index 87520cc..73f1852 100644
--- a/docker/api/plugin.py
+++ b/docker/api/plugin.py
@@ -110,8 +110,8 @@ class PluginApiMixin(object):
remote (string): Remote reference for the plugin to install.
The ``:latest`` tag is optional, and is the default if
omitted.
- privileges (list): A list of privileges the user consents to
- grant to the plugin. Can be retrieved using
+ privileges (:py:class:`list`): A list of privileges the user
+ consents to grant to the plugin. Can be retrieved using
:py:meth:`~plugin_privileges`.
name (string): Local name for the pulled plugin. The
``:latest`` tag is optional, and is the default if omitted.
@@ -225,8 +225,8 @@ class PluginApiMixin(object):
tag is optional and is the default if omitted.
remote (string): Remote reference to upgrade to. The
``:latest`` tag is optional and is the default if omitted.
- privileges (list): A list of privileges the user consents to
- grant to the plugin. Can be retrieved using
+ privileges (:py:class:`list`): A list of privileges the user
+ consents to grant to the plugin. Can be retrieved using
:py:meth:`~plugin_privileges`.
Returns:
diff --git a/docker/types/healthcheck.py b/docker/types/healthcheck.py
index 5a6a931..61857c2 100644
--- a/docker/types/healthcheck.py
+++ b/docker/types/healthcheck.py
@@ -8,14 +8,15 @@ class Healthcheck(DictType):
Defines a healthcheck configuration for a container or service.
Args:
-
test (:py:class:`list` or str): Test to perform to determine
container health. Possible values:
- - Empty list: Inherit healthcheck from parent image
- - ``["NONE"]``: Disable healthcheck
- - ``["CMD", args...]``: exec arguments directly.
- - ``["CMD-SHELL", command]``: RUn command in the system's
- default shell.
+
+ - Empty list: Inherit healthcheck from parent image
+ - ``["NONE"]``: Disable healthcheck
+ - ``["CMD", args...]``: exec arguments directly.
+ - ``["CMD-SHELL", command]``: RUn command in the system's
+ default shell.
+
If a string is provided, it will be used as a ``CMD-SHELL``
command.
interval (int): The time to wait between checks in nanoseconds. It
diff --git a/docker/types/services.py b/docker/types/services.py
index c77db16..9031e60 100644
--- a/docker/types/services.py
+++ b/docker/types/services.py
@@ -405,8 +405,9 @@ class DriverConfig(dict):
"""
Indicates which driver to use, as well as its configuration. Can be used
as ``log_driver`` in a :py:class:`~docker.types.ContainerSpec`,
- and for the `driver_config` in a volume
- :py:class:`~docker.types.Mount`.
+ for the `driver_config` in a volume :py:class:`~docker.types.Mount`, or
+ as the driver object in
+ :py:meth:`create_secret`.
Args:
@@ -562,12 +563,12 @@ class Placement(dict):
Placement constraints to be used as part of a :py:class:`TaskTemplate`
Args:
- constraints (list): A list of constraints
- preferences (list): Preferences provide a way to make the
- scheduler aware of factors such as topology. They are provided
- in order from highest to lowest precedence.
- platforms (list): A list of platforms expressed as ``(arch, os)``
- tuples
+ constraints (:py:class:`list`): A list of constraints
+ preferences (:py:class:`list`): Preferences provide a way to make
+ the scheduler aware of factors such as topology. They are
+ provided in order from highest to lowest precedence.
+ platforms (:py:class:`list`): A list of platforms expressed as
+ ``(arch, os)`` tuples
"""
def __init__(self, constraints=None, preferences=None, platforms=None):
if constraints is not None: