Skip to content

Commit 114512a

Browse files
committed
Doc fixes
Signed-off-by: Joffrey F <[email protected]>
1 parent a085362 commit 114512a

File tree

4 files changed

+22
-20
lines changed

4 files changed

+22
-20
lines changed

docker/api/build.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ def build(self, path=None, tag=None, quiet=False, fileobj=None,
9393
shmsize (int): Size of `/dev/shm` in bytes. The size must be
9494
greater than 0. If omitted the system uses 64MB
9595
labels (dict): A dictionary of labels to set on the image
96-
cache_from (list): A list of images used for build cache
97-
resolution
96+
cache_from (:py:class:`list`): A list of images used for build
97+
cache resolution
9898
target (str): Name of the build-stage to build in a multi-stage
9999
Dockerfile
100100
network_mode (str): networking mode for the run commands during

docker/api/plugin.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ def pull_plugin(self, remote, privileges, name=None):
110110
remote (string): Remote reference for the plugin to install.
111111
The ``:latest`` tag is optional, and is the default if
112112
omitted.
113-
privileges (list): A list of privileges the user consents to
114-
grant to the plugin. Can be retrieved using
113+
privileges (:py:class:`list`): A list of privileges the user
114+
consents to grant to the plugin. Can be retrieved using
115115
:py:meth:`~plugin_privileges`.
116116
name (string): Local name for the pulled plugin. The
117117
``:latest`` tag is optional, and is the default if omitted.
@@ -225,8 +225,8 @@ def upgrade_plugin(self, name, remote, privileges):
225225
tag is optional and is the default if omitted.
226226
remote (string): Remote reference to upgrade to. The
227227
``:latest`` tag is optional and is the default if omitted.
228-
privileges (list): A list of privileges the user consents to
229-
grant to the plugin. Can be retrieved using
228+
privileges (:py:class:`list`): A list of privileges the user
229+
consents to grant to the plugin. Can be retrieved using
230230
:py:meth:`~plugin_privileges`.
231231
232232
Returns:

docker/types/healthcheck.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,15 @@ class Healthcheck(DictType):
88
Defines a healthcheck configuration for a container or service.
99
1010
Args:
11-
1211
test (:py:class:`list` or str): Test to perform to determine
1312
container health. Possible values:
14-
- Empty list: Inherit healthcheck from parent image
15-
- ``["NONE"]``: Disable healthcheck
16-
- ``["CMD", args...]``: exec arguments directly.
17-
- ``["CMD-SHELL", command]``: RUn command in the system's
18-
default shell.
13+
14+
- Empty list: Inherit healthcheck from parent image
15+
- ``["NONE"]``: Disable healthcheck
16+
- ``["CMD", args...]``: exec arguments directly.
17+
- ``["CMD-SHELL", command]``: RUn command in the system's
18+
default shell.
19+
1920
If a string is provided, it will be used as a ``CMD-SHELL``
2021
command.
2122
interval (int): The time to wait between checks in nanoseconds. It

docker/types/services.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -405,8 +405,9 @@ class DriverConfig(dict):
405405
"""
406406
Indicates which driver to use, as well as its configuration. Can be used
407407
as ``log_driver`` in a :py:class:`~docker.types.ContainerSpec`,
408-
and for the `driver_config` in a volume
409-
:py:class:`~docker.types.Mount`.
408+
for the `driver_config` in a volume :py:class:`~docker.types.Mount`, or
409+
as the driver object in
410+
:py:meth:`create_secret`.
410411
411412
Args:
412413
@@ -562,12 +563,12 @@ class Placement(dict):
562563
Placement constraints to be used as part of a :py:class:`TaskTemplate`
563564
564565
Args:
565-
constraints (list): A list of constraints
566-
preferences (list): Preferences provide a way to make the
567-
scheduler aware of factors such as topology. They are provided
568-
in order from highest to lowest precedence.
569-
platforms (list): A list of platforms expressed as ``(arch, os)``
570-
tuples
566+
constraints (:py:class:`list`): A list of constraints
567+
preferences (:py:class:`list`): Preferences provide a way to make
568+
the scheduler aware of factors such as topology. They are
569+
provided in order from highest to lowest precedence.
570+
platforms (:py:class:`list`): A list of platforms expressed as
571+
``(arch, os)`` tuples
571572
"""
572573
def __init__(self, constraints=None, preferences=None, platforms=None):
573574
if constraints is not None:

0 commit comments

Comments
 (0)